PrjGetOnDiskFileState function (projectedfslib.h)

Article
10/13/2021

Gets the on-disk file state for a file or directory.

Syntax

HRESULT PrjGetOnDiskFileState(
  [in]  PCWSTR         destinationFileName,
  [out] PRJ_FILE_STATE *fileState
);

Parameters

[in] destinationFileName

A null-terminated Unicode string specifying the full path to the file whose state is to be queried.

[out] fileState

This is a combination of one or more PRJ_FILE_STATE values describing the file state.

Return value

HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) indicates destinationFileName does not exist. HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND) indicates that an intermediate component of the path to destinationFileName does not exist.

Remarks

This routine tells the caller what the ProjFS caching state is of the specified file or directory. For example, the caller can use this routine to determine whether the given item is a placeholder or full file.

A running provider should be cautious if using this routine on files or directories within one of its virtualization instances, as it may cause callbacks to be invoked in the provider. Depending on the design of the provider this may lead to deadlocks.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1809 [desktop apps only]
Minimum supported server	Windows Server [desktop apps only]
Target Platform	Windows
Header	projectedfslib.h

Share via