inc: add documentation

This commit is contained in:
Bill Zissimopoulos 2016-04-14 21:03:17 -07:00
parent c7d802d432
commit 29a5572dc7

View File

@ -106,8 +106,8 @@ typedef struct _FSP_FILE_SYSTEM_INTERFACE
* @param FileName * @param FileName
* The name of the file or directory to be created. * The name of the file or directory to be created.
* @param CaseSensitive * @param CaseSensitive
* Whether to treat the FileName as case-sensitive or case-insensitive. Case-insensitive * Whether to treat the FileName as case-sensitive or case-insensitive. Case-sensitive
* file systems always treat FileName as case-insensitive regardless of this parameter. * file systems always treat FileName as case-sensitive regardless of this parameter.
* @param CreateOptions * @param CreateOptions
* Create options for this request. This parameter has the same meaning as the * Create options for this request. This parameter has the same meaning as the
* CreateOptions parameter of the NtCreateFile API. User mode file systems should typically * CreateOptions parameter of the NtCreateFile API. User mode file systems should typically
@ -150,8 +150,8 @@ typedef struct _FSP_FILE_SYSTEM_INTERFACE
* @param FileName * @param FileName
* The name of the file or directory to be opened. * The name of the file or directory to be opened.
* @param CaseSensitive * @param CaseSensitive
* Whether to treat the FileName as case-sensitive or case-insensitive. Case-insensitive * Whether to treat the FileName as case-sensitive or case-insensitive. Case-sensitive
* file systems always treat FileName as case-insensitive regardless of this parameter. * file systems always treat FileName as case-sensitive regardless of this parameter.
* @param CreateOptions * @param CreateOptions
* Create options for this request. This parameter has the same meaning as the * Create options for this request. This parameter has the same meaning as the
* CreateOptions parameter of the NtCreateFile API. User mode file systems typically * CreateOptions parameter of the NtCreateFile API. User mode file systems typically
@ -765,6 +765,8 @@ FSP_API NTSTATUS FspFileSystemOpSetSecurity(FSP_FILE_SYSTEM *FileSystem,
* buffer has been used so far. * buffer has been used so far.
* @return * @return
* TRUE if the directory information was added, FALSE if there was not enough space to add it. * TRUE if the directory information was added, FALSE if there was not enough space to add it.
* @see
* ReadDirectory
*/ */
FSP_API BOOLEAN FspFileSystemAddDirInfo(FSP_FSCTL_DIR_INFO *DirInfo, FSP_API BOOLEAN FspFileSystemAddDirInfo(FSP_FSCTL_DIR_INFO *DirInfo,
PVOID Buffer, ULONG Length, PULONG PBytesTransferred); PVOID Buffer, ULONG Length, PULONG PBytesTransferred);