Freigeben über


IpcSerializeLicenseWithMetadata function

Used to finalize the metadata of the license and serialize it.

Syntax

HRESULT WINAPI IpcSerializeLicenseWithMetadata(
  _In_       IPC_LICENSE_METADATA_HANDLE hLicenseMetadata,
  _Reserved_ LPVOID                      pvReserved,
  _In_opt_   PCIPC_PROMPT_CTX            pContext,
  _Out_      PIPC_BUFFER                 *ppvLicense
);

Parameters

hLicenseMetadata [in]

Handle representing the license metadata. This can be obtained from the method IpcCreateLicenseMetadataHandle. See Data types for more information about the type of this parameter.

pvReserved

This is a reserved parameter and must be set to NULL.

pContext [in, optional]

Optional pointer to information that helps the IPC Client decide what the user prompt behavior should be.

This can be used in cases where authentication prompts are not desirable or when an application wants to control the modal behavior of any prompt dialogs.

ppvLicense [out]

Pointer to the pointer to the buffer for serialized license with metadata.

The buffer is allocated by the API and must be freed using 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.

Possible values include, but are not limited to, those in the following list.

E_INVALIDARG

E_OUTOFMEMORY

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

License metadata property types

Notification preference

Notification type

IpcCreateLicenseMetadataHandle

IpcSetLicenseMetadataProperty

IpcSerializeLicenseWithMetadata

IpcfEncryptFileWithMetadata

IpcfEncryptFileStreamWithMetadata

IpcRegisterLicense