IpcSetLicenseProperty function

Sets license properties for the platform.


HRESULT WINAPI IpcSetLicenseProperty(
  _In_     IPC_LICENSE_HANDLE hLicense,
           BOOL               fDelete,
           DWORD              dwPropID,
  _In_opt_ LPCVOID            pvProperty


hLicense [in]

A handle to the license to be modified.


Set to TRUE to delete the existing information in the license. When set to TRUE; pvProperty is ignored.

Set to FALSE to replace the license info for the property specified by dwPropId with the value specified by pvProperty; pvProperty cannot be NULL.


The ID of the license property to modify. The data specified by pvProperty must match this type. For a list of valid property IDs, see License property types.

pvProperty [in, optional]

A pointer to the license information data to be written. If fDelete is false, this parameter cannot be NULL. The structure of the data depends on the property ID specified in dwPropID. For more information, see License 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.


Meaning: The fDelete parameter is TRUE, but the license property specified by the dwPropID parameter is not a property that can be deleted with this function. For more information about which properties cannot be deleted with IpcSetLicenseProperty, see License property types.

Action: Do not try to delete the specified property with this function.


Minimum supported client
Windows Vista with SP2
Minimum supported server
Windows Server 2008
Ipcprot.h (include Msipc.h)

See also



License property types

Error codes