Share via


IpcGetKeyProperty function

Returns requested property information.

Syntax

HRESULT WINAPI IpcGetKeyProperty(
  _In_       IPC_KEY_HANDLE hKey,
             DWORD          dwPropID,
  _Reserved_ LPVOID         pvReserved,
  _Out_      LPVOID         *ppvProperty
);

Parameters

hKey [in]

A handle to the key object.

dwPropID

The ID of the property to query.

IPC_KI_BLOCK_SIZE (2)

ppvProperty is of type LPDWORD*.

The block size used when encrypting/decrypting.

IPC_KI_LICENSE (6)

ppvProperty is of type PIPC_BUFFER*. For more information, see AD RMS data types.

The license from which the key object was created.

See IpcGetKey for details.

IPC_KI_USER_DISPLAYNAME (7)

ppvProperty is of type LPWSTR*.

The user for which the key is acquired.

pvReserved

This parameter is reserved for future use. It must be NULL.

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 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
Ipcprot.h (include Msipc.h)
Library
Msipc.lib
DLL
Msipc.dll

See also

AD RMS data types

IpcFreeMemory

IpcGetKey

Error codes