FSCTL_SET_REPARSE_POINT

[This is preliminary documentation and subject to change.]

The FSCTL_SET_REPARSE_POINT operation sets a reparse point on a file or directory. To perform this operation, call the DeviceIoControl function with the following parameters.

BOOL DeviceIoControl(
  (HANDLE) hDevice,        // handle to the file or directory
  FSCTL_SET_REPARSE_POINT, // dwIoControlCode, control code of
                           // operation to perform
  (LPVOID) lpInBuffer,     // pointer to REPARSE_DATA_BUFFER
                           // structure
  (DWORD) nInBufferSize,   // size, in bytes, of lpInBuffer
  NULL,                    // lpOutBuffer is not used; must be NULL
  0,                       // nOutBufferSize is not used;
                           // must be zero
  (LPDWORD) lpBytesReturned,   // pointer to variable to receive
                           // output byte count
  (LPOVERLAPPED) lpOverlapped  // pointer to OVERLAPPED structure
                           // for asynchronous operation
);

Parameters

hDevice

Handle to the file or directory on which to set a reparse point. The handle must have write access to the file or directory. To obtain a device handle, call the CreateFile function.

dwIoControlCode

Control code for the operation. This value identifies the specific operation to be performed and the type of device on which the operation is to be performed. Use FSCTL_SET_REPARSE_POINT for this operation.

lpInBuffer

Pointer to a REPARSE_DATA_BUFFER buffer that contains the reparse point data.

nInBufferSize

Size, in bytes, of the lpInBuffer buffer.

lpOutBuffer

Pointer to the output buffer. Not used; must be NULL

nOutBufferSize

Size, in bytes, of the output buffer. Not used; must be zero.

lpBytesReturned

Pointer to a DWORD variable.

If lpOverlapped is NULL (nonoverlapped I/O), lpBytesReturned is used internally and cannot be NULL.

If lpOverlapped is not NULL (overlapped I/O), lpBytesReturned can be NULL.

lpOverlapped

Pointer to an OVERLAPPED structure.

If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, this parameter must point to a valid OVERLAPPED structure. In this case, DeviceIoControl is performed as an overlapped (asynchronous) operation. If the device was opened with the FILE_FLAG_OVERLAPPED flag and lpOverlapped is NULL, the function fails in unpredictable ways.

If hDevice was opened without specifying the FILE_FLAG_OVERLAPPED flag, this parameter is ignored and the DeviceIoControl function does not return until the operation has been completed, or until an error occurs.

Return Values

If the operation succeeds, DeviceIoControl returns a nonzero value.

If the operation fails, DeviceIoControl returns zero. For extended error information, call GetLastError.

Remarks

See the Remarks section of the DeviceIoControl topic for the implications of overlapped I/O on this operation.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winioctl.h.

See Also

Device Input and Output Overview, Device Input and Output Operations, DeviceIoControl, FSCTL_GET_REPARSE_POINT, FSCTL_DELETE_REPARSE_POINT, REPARSE_DATA_BUFFER