fpConfigureRMS()

This function provides a way to set the credentials required to access Azure RMS protected files. After you set these credentials, the HTML Export and File Extraction API functions can operate on the contents of the Azure RMS files.

The Rights Management Service (RMS) technology underpins a variety of protection services, which may be known as Azure Information Protection (AIP), Microsoft Information Protection (MIP or MSIP), or Microsoft Purview. This function supports decryption of files created from any of these services.

Syntax

KVErrorCode pascal *fpConfigureRMS(
    void*             pContext,
    KVRMSCredentials* credentials);

Arguments

pContext	A pointer to an Export session that you initialized by calling fpInit().
credentials	A pointer to a KVRMSCredentials structure that contains the required credentials. See KVRMSCredentials. Set this value to NULL to discard the existing credentials. You can call the function again with new credentials to override the existing configuration. Before you fill out the KVRMSCredentials structure, use the macro KVStructInit to initialize the KVStructHead structure.

Returns

The return value is an error code. See KVErrorCode.

Discussion

• This function runs in process or out-of-process. See Convert Files Out-of-Process.

• When converting out-of-process, this function must be called after the call to KVHTMLStartOOPSession() and before the call to KVHTMLEndOOPSession().

• Azure RMS decryption is licensed as an additional product.
• If your license does not allow for Azure RMS decryption, fpConfigureRMS() returns the error code KVError_ReaderUsageDenied.

• To access the protected content, File Content Extraction must make an HTTP request. The time required to do so means that protected files take longer to process than unprotected files.

• By default, File Content Extraction uses the system proxy when it makes HTTP requests to obtain the key. You can also specify the proxy manually in the configuration file. See Configure the Proxy for RMS.

• This function is supported only on certain platforms, see RMS Decryption in the platform differences section.