CfGetPlaceholderRangeInfo function (cfapi.h)

Gets range information about a placeholder file or folder.

Syntax

HRESULT CfGetPlaceholderRangeInfo(
  [in]            HANDLE                          FileHandle,
  [in]            CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
  [in]            LARGE_INTEGER                   StartingOffset,
  [in]            LARGE_INTEGER                   Length,
  [out]           PVOID                           InfoBuffer,
  [in]            DWORD                           InfoBufferLength,
  [out, optional] PDWORD                          ReturnedLength
);

Parameters

[in] FileHandle

The handle of the placeholder file to be queried.

[in] InfoClass

Types of the range of placeholder data.

[in] StartingOffset

Offset of the starting point of the range of data.

[in] Length

Length of the range of data. A provider can specify CF_EOF for Length to indicate that range for which information is requested is from StartingOffset to end of the file.

[out] InfoBuffer

Pointer to a buffer that will receive the data. The buffer is an array of CF_FILE_RANGE structures, which are offset/length pairs, describing the requested ranges.

[in] InfoBufferLength

The length of InfoBuffer in bytes.

[out, optional] ReturnedLength

The length of the returned range of placeholder data in the InfoBuffer.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. Some common error codes are listed in the following table:

Remarks

Unlike most placeholder APIs that take a file handle, this one does not modify the file in any way, therefore the file handle only requires READ_ATTRIBUTES access.

Requirements

See also

CfGetPlaceholderRangeInfoForHydration