DRMSetNameAndDescription function (msdrm.h)

Article
02/22/2024

[The AD RMS SDK leveraging functionality exposed by

the client in Msdrm.dll is available for use in Windows Server 2008, Windows Vista, Windows Server 2008 R2, Windows 7, Windows Server 2012, and Windows 8. It may be altered or

unavailable in subsequent versions. Instead, use Active Directory Rights Management Services SDK 2.1,

which leverages functionality exposed by the client in Msipc.dll.]

The DRMSetNameAndDescription function allows an application to specify names and descriptions of the license in multiple (human) languages.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMSetNameAndDescription(
  [in] DRMPUBHANDLE hIssuanceLicense,
  [in] BOOL         fDelete,
  [in] UINT         lcid,
  [in] PWSTR        wszName,
  [in] PWSTR        wszDescription
);

Parameters

[in] hIssuanceLicense

A handle to an issuance license.

[in] fDelete

Flag indicating whether the existing item should be deleted: TRUE indicates it should be deleted; FALSE indicates it should be added.

[in] lcid

A locale ID for this name and description. If lcid is given as NULL or zero, the name and description given become the default license name and description. There may be only one name and description for any LCID (locale identifier).

[in] wszName

A license name, in the language specified by this locale.

[in] wszDescription

An optional license description, in the language specified by this locale.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following list. For a list of common error codes, see Common HRESULT Values.

Remarks

This function allows a license to be distributed internationally. A consuming application can display the localized name and description of the license.

Note To set a default language for Name and Description, you can set the locale ID to 0. Take note that this is supported only for templates and licenses created programmatically on the client. AD RMS server administration does not support setting a default language for Name and Description. For more information about creating an issuance license programmatically, see Creating an Issuance License.

Requirements

Requirement	Value
Target Platform	Windows
Header	msdrm.h
Library	Msdrm.lib
DLL	Msdrm.dll