staffilesystem.h

Software Testing Automation Framework (STAF)的开发代码

/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSExists(STAFStringConst_t path, unsigned int *exists,
                      unsigned int *osRC);


/*****************************************************************************/
/* STAFFSGetEntry - Retrives an entry object representing the file system    */
/*                  entry                                                    */
/*                                                                           */
/* Accepts: (In)  Path string                                                */
/*          (Out) Pointer to the file system entry                           */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSGetEntry(STAFStringConst_t path, STAFFSEntry_t *entry,
                        unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetPathString - Gets the path string associated with an entry  */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to constant path string                            */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*                                                                           */
/* Notes  : 1) This API returns a canonical path string.  This is not        */
/*             necessarily the same string as used in STAFFSGetEntry().      */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetPathString(STAFFSEntry_t entry,
                                  STAFStringConst_t *pathString,
                                  unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetType - Gets the type associated with an entry               */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to entry type                                      */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetType(STAFFSEntry_t entry, STAFFSEntryType_t *type,
                            unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetSize - Gets the size associated with an entry               */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to upper word of size                              */
/*          (Out) Pointer to lower word of size                              */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*                                                                           */
/* Notes  : 1) The size is returned as two 32-bit quantities representing a  */
/*             64-bit quantity                                               */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetSize(STAFFSEntry_t entry, unsigned int *upperSize,
                            unsigned int *lowerSize, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetModTime - Gets the modification time associated with an     */
/*                         entry                                             */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to modification time                               */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetModTime(STAFFSEntry_t entry, time_t *modTime,
                               unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetIsLink - Gets a flag indicating if the entry is a link      */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to flag indicating if the entry is a link          */
/*                1 = link   0 = Not a link                                  */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetIsLink(STAFFSEntry_t entry, unsigned int *isLink,
                              unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryGetLinkTarget - Gets the link target associated with a         */
/*                            symbolic link entry                            */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to constant to (target) link path string           */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryGetLinkTarget(STAFFSEntry_t entry,
                                  STAFString_t *linkTargetString,
                                  unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryReadLock - Gets a read lock on a file system entry             */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryReadLock(STAFFSEntry_t entry, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryReadUnlock - Releases a read lock on a file system entry       */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryReadUnlock(STAFFSEntry_t entry, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryWriteLock - Gets a write lock on a file system entry           */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryWriteLock(STAFFSEntry_t entry, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSEntryWriteUnlock - Releases a write lock on a file system entry     */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSEntryWriteUnlock(STAFFSEntry_t entry, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSDeleteEntry - Deletes a file system entry                           */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*                                                                           */
/* Notes  : 1) This does NOT free the entry itself.  You must still call     */
/*             STAFFSFreeEntry().                                            */
/*****************************************************************************/
STAFRC_t STAFFSDeleteEntry(STAFFSEntry_t entry, unsigned int *osRC);


/*****************************************************************************/
/* STAFFSCopyEntry - Copies one file system entry to another path            */
/*                                                                           */
/* Accepts: (In)  Source file system entry                                   */
/*          (In)  Target path string                                         */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSCopyEntry(STAFFSEntry_t source, STAFStringConst_t target,
                         unsigned int *osRC);

/*****************************************************************************/
/* STAFFSMoveEntry - Moves one file system entry to another name.  If the    */
/*                   target already exists, it is overwritten.               */
/*                                                                           */
/* Accepts: (In)  Source file system entry (file to be moved)                */
/*          (In)  Target path string (new file name)                         */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSMoveEntry(STAFFSEntry_t source, STAFStringConst_t target,
                         unsigned int *osRC);

/*****************************************************************************/
/* STAFFSRenameEntry - Renames one file system entry to another name.  The   */
/*                     target must not already exist.                        */
/*                                                                           */
/* Accepts: (In)  Source file system entry (file to be renamed)              */
/*          (In)  Target path string (new file name)                         */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSRenameEntry(STAFFSEntry_t source, STAFStringConst_t target,
                           unsigned int *osRC);


/*****************************************************************************/
/* STAFFSFreeEntry - Frees a file system entry object                        */
/*                                                                           */
/* Accepts: (In)  File system entry                                          */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSFreeEntry(STAFFSEntry_t *entry);


/*****************************************************************************/
/*                             Directory APIs                                */
/*****************************************************************************/

/*****************************************************************************/
/* STAFFSCreateDirectory - Creates a directory in the file system            */
/*                                                                           */
/* Accepts: (In)  Path string                                                */
/*          (In)  Directory creation flags                                   */
/*          (Out) Pointer to unsigned int indicating operating system error  */
/*                                                                           */
/* Returns: Standard return codes                                            */
/*****************************************************************************/
STAFRC_t STAFFSCreateDirectory(STAFStringConst_t path,
                               STAFFSDirectoryCreateMode_t flags,