IpcfGetFileProperty function

Queries the properties of an IPCF_FILE_HANDLE or the file represented by it.

Syntax

EXTERN_C HRESULT WINAPI IpcfGetFileProperty(
  _In_  IPCF_FILE_HANDLE hFile,
  _In_  DWORD            dwPropId,
  _Out_ LPVOID           *ppvProperty
);

Parameters

hFile [in]

Handle properties to be queried.

dwPropId [in]

Which file property to query.

The ppvProperty parameter must match this property ID.

IPCF_FI_HEADER_POSITION (1)

Describes the file range indicating the offset and size of the protected file header.

Note

For IpcfGetFilePropertyppvProperty is of type PIPCF_FILE_RANGE*.

IPCF_FI_CONTENT_KEY (2)

[!Important]
This is currently not implemented and returns E_NOTIMPL if called.

Describes the handle to the key which is used to protect the content of the file specified by parameter hFile.

Note

For IpcfGetFilePropertyppvProperty is of type IPC_KEY_HANDLE*.

IPCF_FI_ACCESS_BLOCK_SIZE (3)

Specifies the size of blocks with which the data will be accessed.

Note

For IpcfGetFilePropertyppvProperty is of type LPDWORD*.

IPCF_FI_BASIC_INFORMATION (4)

[!Important]
This is currently not implemented and returns E_NOTIMPL if called.

Specifies the basic information about the file represented by the parameter hFile.

Note

For IpcfGetFilePropertyppvProperty is of type PIPCF_FILE_BASIC_INFORMATION*.

ppvProperty [out]

A pointer to a variable that receives a pointer to the buffer that contains the property information.

The structure of the property information depends on the dwPropID parameter.

Note

The buffer is allocated by the AD RMS SDK 2.1 and must be freed by calling IpcFreeMemory.

Return value

If the function succeeds, the return value is S_OK. If the function fails, it returns an HRESULT value that indicates the error.

For more information, see Error codes for a description of all RMS SDK 2.1 return values.

Requirements

Minimum supported client	Windows Vista with SP2
Minimum supported server	Windows Server 2008
Header	Ipcfile.h (include Msipc.h)
Library	Msipc.lib
DLL	Msipc.dll