DosFSCtl - Parameters

pData (PVOID) - input

Address of the data area.

cbData (ULONG) - input

The length, in bytes, of pData.

This is the maximum length of the data to be returned by the file-system driver in pData. pcbData may be larger than this on input, but not on output.

pcbData (PULONG) - in/out

Pointer to the length of data passed to or returned from the FSD.

Input

Pointer to the length, in bytes, of the data passed to the file-system driver in pData
Output
Pointer to the length, in bytes, of the data returned by the file-system driver in pData. If this function returns ERROR_BUFFER_OVERFLOW, pcbData points to the size of the buffer required to hold the data returned by the file-system driver.

pParms (PVOID) - input

Address of the command-specific parameter list.

cbParms (ULONG) - input

The length, in bytes, of pParms.

This is the maximum length of the data to be returned by the file-system driver in pParms. pcbParms may be larger than this on input, but not on output.

pcbParms (PULONG) - in/out

Pointer to the length of the parameters passed to or returned from the FSD.

Input

Pointer to the length, in bytes, of the parameters passed to the file-system driver in pParms.
Output
Pointer to the length, in bytes, of the parameters returned by the file-system driver in pParms. If this function returns ERROR_BUFFER_OVERFLOW, pcbParms. points to the size of the buffer required to hold the parameters returned by the file-system driver. No other data is returned in this case.

function (ULONG) - input

The function code that is specific to the file-system driver.

For remote file-system drivers, two kinds of DosFSCtl functions are possible: functions that are handled locally, and functions that are exported across the network. If bit 0x4000 is set in function, this indicates to the remote file-system driver (FSD) that the function should be exported.

Function codes from 0x0000 to 0x7FFF are reserved for use by the operating system. Function codes from 0x8000 to 0xBFFF are FSD-defined DosFSCtl functions handled by the local file-system driver. Function codes from 0xC000 to 0xFFFF are FSD-defined DosFSCtl functions exported to the server.

function may have one of the following values:

• FSCTL_ERROR_INFO Returns error-code information from the file-system driver.

  Input

  The error code is passed to the file-system driver in the first word of pParms.
  Output
  The ASCIIZ string returned in pData is an explanation of the error code.
  2
  FSCTL_MAX_EASIZE
  Queries the file-system driver for the maximum size of individual EAs (extended attributes), and the maximum size of the full EA list that it supports. The information is returned in pData in the form of an EASIZEBUF structure.

  pszRoute (PSZ) - input

  Address of the ASCIIZ name of the FSD, or the path name of a file or directory that the operation applies to.

  This parameter must be a null pointer (OL) If method is equal to FSCTL_HANDLE

  hFile (HFILE) - input

  File-specific or device-specific handle.

  This parameter must be -1 when method is equal to FSCTL_PATHNAME or FSCTL_FSDNAME.

  method (ULONG) - input

  Method used to routed the request.

  Possible values are shown in the following list:

  • FSCTL_HANDLE hFile directs routing. pszRoute must be a null pointer (0L). The file-system driver associated with the handle receives the request.

  • FSCTL_PATHNAME
    pszRoute refers to a path name that directs routing. hFile must be -1. The file-system driver associated with the drive that the path name refers to at the time of the request receives the request. The path name need not refer to a file or directory that actually exists, only to a drive. A relative path name may be used; it is processed like any other path name.

  • FSCTL_FSDNAME
    pszRoute refers to a file-system driver name that directs routing. hFile must be -1. The named file-system driver receives the request.

  ulrc (APIRET) - returns

  Return Code.

  DosFSCtl returns one of the following values:

  • NO_ERROR 1
    ERROR_INVALID_FUNCTION
    6
    ERROR_INVALID_HANDLE
    87
    ERROR_INVALID_PARAMETER
    95
    ERROR_INTERRUPT
    111
    ERROR_BUFFER_OVERFLOW
    117
    ERROR_INVALID_CATEGORY
    124
    ERROR_INVALID_LEVEL
    252
    ERROR_INVALID_FSD_NAME
    For a full list of error codes, see Errors.

  ---

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