Home Library Learn Samples Downloads Support Community Forums
MSDN Library
Open Specifications
Protocols
Windows Protocols
Technical Documents
[MS-FSA]: File System Algorithms
2 Algorithm Details
2.1 Object Store Details
2.1.5 Higher-Layer Triggered Events
2.1.5.9 Server Requests an FsControl Request
2.1.5.9.1 FSCTL_CREATE_OR_GET_OBJECT_ID
2.1.5.9.2 FSCTL_DELETE_OBJECT_ID
2.1.5.9.3 FSCTL_DELETE_REPARSE_POINT
2.1.5.9.4 FSCTL_FILE_LEVEL_TRIM
2.1.5.9.5 FSCTL_FILESYSTEM_GET_STATISTICS
2.1.5.9.6 FSCTL_FIND_FILES_BY_SID
2.1.5.9.7 FSCTL_GET_COMPRESSION
2.1.5.9.8 FSCTL_GET_INTEGRITY_INFORMATION
2.1.5.9.9 FSCTL_GET_NTFS_VOLUME_DATA
2.1.5.9.10 FSCTL_GET_OBJECT_ID
2.1.5.9.11 FSCTL_GET_REPARSE_POINT
2.1.5.9.12 FSCTL_GET_RETRIEVAL_POINTERS
2.1.5.9.13 FSCTL_IS_PATHNAME_VALID
2.1.5.9.14 FSCTL_LMR_GET_LINK_TRACKING_INFORMATION
2.1.5.9.15 FSCTL_LMR_SET_LINK_TRACKING_INFORMATION
2.1.5.9.16 FSCTL_OFFLOAD_READ
2.1.5.9.17 FSCTL_OFFLOAD_WRITE
2.1.5.9.18 FSCTL_QUERY_ALLOCATED_RANGES
2.1.5.9.19 FSCTL_QUERY_FAT_BPB
2.1.5.9.20 FSCTL_QUERY_FILE_REGIONS
2.1.5.9.21 FSCTL_QUERY_ON_DISK_VOLUME_INFO
2.1.5.9.22 FSCTL_QUERY_SPARING_INFO
2.1.5.9.23 FSCTL_READ_FILE_USN_DATA
2.1.5.9.24 FSCTL_RECALL_FILE
2.1.5.9.25 FSCTL_SET_COMPRESSION
2.1.5.9.26 FSCTL_SET_DEFECT_MANAGEMENT
2.1.5.9.27 FSCTL_SET_ENCRYPTION
2.1.5.9.28 FSCTL_SET_INTEGRITY_INFORMATION
2.1.5.9.29 FSCTL_SET_OBJECT_ID
2.1.5.9.30 FSCTL_SET_OBJECT_ID_EXTENDED
2.1.5.9.31 FSCTL_SET_REPARSE_POINT
2.1.5.9.32 FSCTL_SET_SHORT_NAME_BEHAVIOR
2.1.5.9.33 FSCTL_SET_SPARSE
2.1.5.9.34 FSCTL_SET_ZERO_DATA
2.1.5.9.35 FSCTL_SET_ZERO_ON_DEALLOCATION
2.1.5.9.36 FSCTL_SIS_COPYFILE
2.1.5.9.37 FSCTL_WRITE_USN_CLOSE_RECORD
Expand Minimize
This topic has not yet been rated - Rate this topic

2.1.5.9.11 FSCTL_GET_REPARSE_POINT

The server provides:

  • Open: An Open of a DataFile or DirectoryFile.

  • OutputBufferSize: The maximum number of bytes to return in OutputBuffer.

On completion, the object store MUST return:

  • OutputBuffer: An array of bytes containing a REPARSE_DATA_BUFFER or REPARSE_GUID_DATA_BUFFER structure as defined in [MS-FSCC] sections 2.1.2.2 and 2.1.2.3, respectively.

  • BytesReturned: The number of bytes returned to the caller.

  • Status: An NTSTATUS code that specifies the result.

Support for this operation is optional. If the object store does not implement this functionality, the operation MUST be failed with STATUS_INVALID_DEVICE_REQUEST.<65>

Pseudocode for the operation is as follows:

  • If Open.File.Volume.IsReparsePointsSupported is FALSE, the operation MUST be failed with STATUS_VOLUME_NOT_UPGRADED.

  • Phase 1 -- Check whether there is a reparse point on the File

  • If Open.File.ReparseTag is empty, the operation MUST be failed with STATUS_NOT_A_REPARSE_POINT.

  • Phase 2 -- Verify that OutputBufferSize is large enough to contain the reparse point data header.

  • If Open.File.ReparseTag is a Microsoft reparse tag as defined in [MS-FSCC] section 2.1.2.1, then OutputBufferSize MUST be >= sizeof(REPARSE_DATA_BUFFER). If not, the operation MUST be failed with STATUS_BUFFER_TOO_SMALL.

  • If Open.File.ReparseTag is a non-Microsoft reparse tag, then OutputBufferSize MUST be >= sizeof(REPARSE_GUID_DATA_BUFFER). If it is not, the operation MUST be failed with STATUS_BUFFER TOO_SMALL.

  • Phase 3 -- Return the reparse data

  • Set OutputBuffer.ReparseTag to Open.File.ReparseTag.

  • Set OutputBuffer.ReparseDataLength to the size of Open.File.ReparseData, in bytes.

  • Set OutputBuffer.Reserved to zero.

  • Copy as much of Open.File.ReparseData as can fit into the remainder of OutputBuffer starting at OutputBuffer.DataBuffer.

  • If Open.File.ReparseTag is a non-Microsoft reparse tag, set OutputBuffer.ReparseGUID to Open.File.ReparseGUID.

  • Upon successful completion of the operation, the object store MUST return:

    • BytesReturned set to the number of bytes written to OutputBuffer.

    • Status set to STATUS_SUCCESS.

 
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.