DosProtectQueryFileInfo - Parameters

hf (HFILE) - input

File handle.

ulInfoLevel (ULONG) - input

Level of file information required.

A value of 1, 2, or 3 can be specified, as shown in the following list:

• FIL_STANDARD Level 1 file information

• FIL_QUERYEASIZE
  Level 2 file information

• FIL_QUERYEASFROMLIST
  Level 3 file information

  Level 4 is reserved.

  The structures described in pInfo indicate the information returned for each of these levels.

pInfo (PVOID) - output

Address of the storage area where the system returns the requested level of file information.

File information, where applicable, is at least as accurate as the most recent DosProtectClose, DosResetBuffer, DosProtectSetFileInfo, or DosSetPathInfo.

Level 1 File Information (ulInfoLevel == FIL_STANDARD)

pInfo contains the FILESTATUS3 data structure, to which file information is returned.
Level 2 File Information (ulInfoLevel == FIL_QUERYEASIZE)
pInfo contains the FILESTATUS4 data structure. This is similar to the Level 1 structure, with the addition of the cbList field after the attrFile field.

The cbList field is an ULONG. On output, this field contains the size, in bytes, of the file's entire extended attribute (EA) set on disk. You can use this value to calculate the size of the buffer required to hold the EA information returned when a value of 3 is specified for ulInfoLevel. The buffer size is less than or equal to twice the size of the file's entire EA set on disk.

Level 3 File Information (ulInfoLevel == FIL_QUERYEASFROMLIST)

Input

pInfo contains an EAOP2 data structure. fpGEA2List points to a GEA2 list defining the attribute names whose values are returned. The GEA2 data structures must be aligned on a doubleword boundary. Each oNextEntryOffset field must contain the number of bytes from the beginning of the current entry to the beginning of the next entry in the GEA2 list. The oNextEntryOffset field in the last entry of the GEA2 list must be zero. fpFEA2List points to a data area where the relevant FEA2 list is returned. The length field of this FEA2 list is valid, giving the size of the FEA2 list buffer. oError is ignored.
Output
pInfo is unchanged. The buffer pointed to by fpFEA2List is filled in with the returned information. If the buffer that fpFEA2List points to is not large enough to hold the returned information (the return code is ERROR_BUFFER_OVERFLOW), cbList is still valid, assuming there is at least enough space for it. Its value is the size of the entire EA set on disk for the file, even though only a subset of attributes was requested.

cbInfoBuf (ULONG) - input

The length, in bytes, of pInfo.

fhFileHandleLockID (FHLOCK) - input

The filehandle lockid returned by a previous DosProtectOpen.

ulrc (APIRET) - returns

Return Code.

DosProtectQueryFileInfo returns one of the following values:

• NO_ERROR 5
  ERROR_ACCESS_DENIED
  6
  ERROR_INVALID_HANDLE
  111
  ERROR_BUFFER_OVERFLOW
  124
  ERROR_INVALID_LEVEL
  130
  ERROR_DIRECT_ACCESS_HANDLE
  254
  ERROR_INVALID_EA_NAME
  255
  ERROR_EA_LIST_INCONSISTENT
  For a full list of error codes, see Errors.

---

[Back: DosProtectQueryFileInfo Return Value - ulrc]
[Next: DosProtectQueryFileInfo - Remarks]