Export (0) Print
Expand All

FSCTL_SET_REPARSE_POINT control code

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 file or directory
                      FSCTL_SET_REPARSE_POINT,       // dwIoControlCode
                      (LPVOID) lpInBuffer,           // input buffer 
                      (DWORD) nInBufferSize,         // size of input buffer
                      NULL,                          // lpOutBuffer
                      0,                             // nOutBufferSize
                      NULL,                          // lpBytesReturned
                      (LPOVERLAPPED) lpOverlapped ); // OVERLAPPED structure

Parameters

hDevice

A 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 retrieve a handle, use the CreateFile function.

dwIoControlCode

The control code for the operation. Use FSCTL_SET_REPARSE_POINT for this operation.

lpInBuffer

A pointer to a buffer that contains the reparse point data. If the reparse tag is a Microsoft reparse tag, the data is a REPARSE_DATA_BUFFER structure. Otherwise, the data is a REPARSE_GUID_DATA_BUFFER structure.

nInBufferSize

The size of the input buffer, in bytes. This value must be at least the size indicated by REPARSE_GUID_DATA_BUFFER_HEADER_SIZE, plus the size of any user-defined data.

lpOutBuffer

Not used with this operation; set to NULL.

nOutBufferSize

Not used with this operation; set to zero.

lpBytesReturned

Not used with this operation; set to NULL.

lpOverlapped

A pointer to an OVERLAPPED structure.

If hDevice was opened without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is ignored.

If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, the operation is performed as an overlapped (asynchronous) operation. In this case, lpOverlapped must point to a valid OVERLAPPED structure that contains a handle to an event object. Otherwise, the function fails in unpredictable ways.

For overlapped operations, DeviceIoControl returns immediately, and the event object is signaled when the operation has been completed. Otherwise, the function does not return until the operation has been completed or an error occurs.

Return value

If the operation completes successfully, DeviceIoControl returns a nonzero value.

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

Remarks

For the implications of overlapped I/O on this operation, see the Remarks section of DeviceIoControl.

Note that the time stamps may not be updated correctly for a remote file. To ensure consistent results, use unbuffered I/O.

In Windows 8 and Windows Server 2012, this code is supported by the following technologies.

TechnologySupported

Server Message Block (SMB) 3.0 protocol

Yes

SMB 3.0 Transparent Failover (TFO)

Yes

SMB 3.0 with Scale-out File Shares (SO)

Yes

Cluster Shared Volume File System (CsvFS)

No

Resilient File System (ReFS)

Yes

 

CsvFs does not support reparse points.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

DeviceIoControl
FSCTL_GET_REPARSE_POINT
FSCTL_DELETE_REPARSE_POINT
Reparse Points
REPARSE_DATA_BUFFER
REPARSE_GUID_DATA_BUFFER

 

 

Community Additions

ADD
Show:
© 2014 Microsoft