Functions

The platform provides the following functions.

Note that the functions relating to the File API, prefaced with Ipcf rather than Ipc, are grouped together at the end of the functions listing.

Note  For error condition processing, always use a call to IpcGetErrorMessageText right after an SDK API call fails, so you get complete information about the nature of the error.
 

In this section

IPC_OAUTH2_CALLBACK

A pointer to a function that is called when the RMS client requests an OAuth authentication token.

IpcAccessCheck

Checks whether a key object grants the requested right.

IpcCloseHandle

Closes a handle.

IpcCreateLicenseFromScratch

Returns a handle to a license created from scratch.

IpcCreateLicenseFromTemplateID

Returns a handle to a license created from a template.

IpcCreateLicenseMetadataHandle

Creates a handle for create or modify operations on the metadata of the serialized license.

IpcCreateOAuth2Token

Returns a handle to an authentication token object that is created from an authentication token string.

IpcDecrypt

Decrypts encrypted data.

IpcEncrypt

Encrypts plaintext data.

IpcFreeMemory

Frees a buffer allocated by another Rights Management Services SDK 2.1 function.

IpcGetErrorMessageText

Returns the error message text associated with a supplied error code.

IpcGetGlobalProperty

Returns information about environment properties.

IpcGetKey

Returns a handle to a key object created from a serialized license.

IpcGetKeyProperty

Returns requested property information.

IpcGetLicenseProperty

Returns information about a license.

IpcGetSerializedLicenseProperty

Retrieves the information available from a serialized license.

IpcGetTemplateIssuerList

Returns available issuers of rights policy templates.

IpcGetTemplateList

Returns official rights policy templates.

IpcInitialize

Locates the installed version of Msipc.dll and calls the Windows LoadLibrary against it.

IpcProtectWindow

Protects a window by using mechanisms available on the current operating system.

IpcSerializeLicense

Serializes a license.

IpcSetGlobalProperty

Sets environment properties for the system.

IpcSetLicenseProperty

Sets license properties for the platform.

IpcUnprotectWindow

Removes the protection from a window protected using IpcProtectWindow.

IpcRegisterLicense

Used to register the license with server.

IpcSerializeLicenseWithMetadata

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

IpcSetLicenseMetadataProperty

Used to set the metadata of the license.

File API

Functions relating to the File API.

 

 

Show: