IpcfSetFileProperty function

Sets the properties on IPCF_FILE_HANDLE or on the file represented by it.

Syntax

EXTERN_C HRESULT WINAPI IpcfSetFileProperty(
  _In_ IPCF_FILE_HANDLE hFile,
  _In_ DWORD            dwPropId,
  _In_ LPCVOID          pvProperty
);

Parameters

hFile [in]

Handle properties to be set.

dwPropId [in]

Type of file property to modify.

The pvProperty parameter must match this type.

IPCF_FI_HEADER_POSITION (1)

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

Note

For IpcfSetFileProperty cannot set this property.

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 IpcfSetFileProperty cannot set this property.

IPCF_FI_ACCESS_BLOCK_SIZE (3)

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

Note

For IpcfSetFilePropertypvProperty 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 IpcfSetFilePropertypvProperty is of type PCIPCF_FILE_BASIC_INFORMATION.

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