File Content Extraction 25.1
Filter SDK C Programming Guide

# fpConfigureRMS()

This function provides a way to set the credentials required to access Azure RMS protected files. After you set these credentials, the Filter 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(
        KVFilterSession   session,
        KVRMSCredentials* credentials);

## Arguments

`session` | A Filter 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

- Azure RMS decryption is licensed as an additional product. If your license does not allow for Azure RMS decryption, this function returns the extended 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.

CAUTION: When Filter or File Extraction API functions access the protected contents of Azure RMS-protected files, File Content Extraction may place decrypted contents into the temporary directory. If you want to manage the security of such files, you might want to change the temporary directory. For information about how to configure the location of the temporary directory, see Protect the Temporary Directory.

Copyright 1997-2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: File Content Extraction 25.1

Topic Title: fpConfigureRMS()