2.1.5.10.28 FSCTL_RECALL_FILE

  • Article

The server provides:

  • Open: An Open of a DataFile.

On completion, the object store MUST return:

  • 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.<114>

Pseudocode for the operation is as follows:

  • If Open.File.FileType is DirectoryFile, the operation MUST be failed with STATUS_INVALID_HANDLE.

    • If Open.File.FileAttributes.FILE_ATTRIBUTE_OFFLINE is not set:

      • // The file has already been recalled.

    • Else

      • Recall Open.File from remote storage.

      • Clear Open.File.FileAttributes.FILE_ATTRIBUTE_OFFLINE

    • EndIf

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

    • Status set to STATUS_SUCCESS.