RtlIsPartialPlaceholderFileHandle function (ntifs.h)

  • Article

The RtlIsPartialPlaceholderFileHandle routine determines if a file is a known type of placeholder, based on a file handle.

Syntax

NTSYSAPI NTSTATUS RtlIsPartialPlaceholderFileHandle(
  [in]  HANDLE   FileHandle,
  [out] PBOOLEAN IsPartialPlaceholder
);

Parameters

[in] FileHandle

FileHandle is a handle to the placeholder file whose partial state is to be queried. The file handle must have at least FILE_READ_ATTRIBUTES access.

[out] IsPartialPlaceholder

IsPartialPlaceholder is a pointer to a boolean which is TRUE if the file or directory is a placeholder. It returns FALSE if either the file or directory is not a placeholder or is a full placeholder; undefined on failure.

Return value

Returns STATUS_SUCCESS if IsPartialPlaceholder is valid and not undefined.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1709.
Target Platform Windows
Header ntifs.h (include Ntifs.h)

See also

RtlIsPartialPlaceholder