IpcSetLicenseMetadataProperty function

Used to set the metadata of the license.

Syntax

HRESULT WINAPI IpcSetLicenseMetadataProperty(
  _In_     IPC_LICENSE_METADATA_HANDLE hLicenseMetadata,
           BOOL                        fDelete,
           DWORD                       dwPropID,
  _In_opt_ LPCVOID                     pvProperty
);

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.

fDelete

If this parameter is TRUE, the property specified by dwPropID will be deleted from the license.

The parameter, pvProperty should be NULL if this is TRUE.

dwPropID

Type of license metadata property to modify.

The pvProperty parameter must match this type.

For a list of valid IDs, License metadata property types.

pvProperty [in, optional]

Pointer to various types of license information data.

For more information, see License metadata property types.

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

Requirements

See also

License metadata property types

Notification preference

Notification type

IpcCreateLicenseMetadataHandle

IpcSetLicenseMetadataProperty

IpcSerializeLicenseWithMetadata

IpcfEncryptFileWithMetadata

IpcfEncryptFileStreamWithMetadata

IpcRegisterLicense