# fpConfigureRMS()

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

## Syntax

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

## Arguments

`pContext` | A pointer returned from fpInit() or fpInitWithLicenseData().
`credentials` | A pointer to a `KVRMSCredentials` structure that contains the required credentials. 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.

If the function returns `KVERR_General`, you can retrieve the extended error code by using the `fpGetKvErrorCodeEx()` function (see fpGetKvErrorCodeEx()).

## Discussion

- This function runs in process or out of process. See The Filter Process Model.

- RMS decryption is licensed as an additional product. If your license does not allow for RMS decryption, this function returns the extended error code `KVError_ReaderUsageDenied`.

- To access the protected content, KeyView must make an HTTP request. The time required to do so means that KeyView processes protected files slower than unprotected files.

- By default, KeyView 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 Windows 64-bit, Linux 64-bit, Solaris SPARC 64-bit, and Solaris x86 64-bit. On Linux 64-bit, the minimum supported versions of particular distributions are:

  - Red Hat Enterprise Linux (RHEL) 6

  - CentOS 6

  - SuSE Linux Enterprise Server (SLES) 12

  - Ubuntu 14.04

  - Debian 8

CAUTION: When Filter or File Extraction API functions access the protected contents of RMS-protected files, KeyView 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, by using fpFilterConfig().

© Copyright 2016-2020 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm