---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FILE / V3-7-3

Constituent: file_path     Tag: rad750

---

         

---

FILE_path.h File Reference

File Path Utility Library. More...

#include "FILE/FILE_path_msg.h"
#include "FILE/FILE_defs.h"

Include dependency graph for FILE_path.h:

This graph shows which files directly or indirectly include this file:

Functions
unsigned int	FILE_pathInit (const char *usrName5, const char *usrName6)
	Initialize the file path mapping library.
unsigned int	FILE_pathSizeof (void)
	Get the size of a file path string.
unsigned int	FILE_pathIdToNum (unsigned int id, unsigned int *dev, unsigned int *dir, unsigned int *file)
	Translates a file ID word into component numbers.
unsigned int	FILE_pathNumToId (unsigned int *id, unsigned int dev, unsigned int dir, unsigned int file)
	Translates file component numbers to an ID word.
unsigned int	FILE_pathIdToPath (unsigned int id, char *str)
	Translates file ID word to an ASCII path name.

---

Detailed Description

File Path Utility Library.

Author:

D.L. Wood

This library contains functions for manipulating LAT file ID and path elements.

---

Function Documentation

unsigned int FILE_pathIdToNum (  unsigned int  id, unsigned int *  dev, unsigned int *  dir, unsigned int *  file )

Translates a file ID word into component numbers. Breaks a file ID word into its numerical components, which are stored in the user supplied dev, dir, and file locations. Parameters: id  The file ID word. dev  Storage for the device number. dir  Storage for the directory number. file  Storage for the file number. Returns: A FILE MSG value.

unsigned int FILE_pathIdToPath (  unsigned int  id, char *  str )

Translates file ID word to an ASCII path name. Creates a file system path string from a set of file ID components. The result is stored in the user supplied str location. The resulting path string is appropriate for use with the file system API functions. Parameters: id  The file ID word. str  Storage for the file path string. Returns: A FILE MSG value.

unsigned int FILE_pathInit (  const char *  usrName5, const char *  usrName6 )

Initialize the file path mapping library. Sets the root partition names for device numbers '5' and '6' (FILE_DEV_NUM_USR0 and FILE_DEV_NUM_USR1). The names from usrName5 and usrName6 will be used when calling function FILE_pathIdToPath(). Parameters: usrName5  Root name for device 5; must start with '/' (use NULL to invalidate). usrName6  Root name for device 6; must start with '/' (use NULL to invalidate). Returns: A FILE MSG value.

unsigned int FILE_pathNumToId (  unsigned int *  id, unsigned int  dev, unsigned int  dir, unsigned int  file )

Translates file component numbers to an ID word. Composes a new file ID word from its numerical components. The result is stored in the user supplied id location. Parameters: id  Storage for the file ID word. dev  The device number. dir  The directory number. file  The file number. Returns: A FILE MSG value.

unsigned int FILE_pathSizeof (  void   )

Get the size of a file path string. Returns the number of bytes needed to hold an on-board file path string. Returns: The path string size in bytes.

---