Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Data Management Methods › ClearText Method—Sets or Retrieves the Clear Text Flag

ClearText Method—Sets or Retrieves the Clear Text Flag

The ClearText method sets or retrieves the clear text flag.

Syntax

The ClearText method has the following format:

Netegrity::PolicyMgtDataMgr‑>ClearText([clearTextFlag])

Parameters

The ClearText method accepts the following parameter:

clearTextFlag (int)

(Optional) Specifies whether to enable clear text input:

• 1 to enable clear text output
• 0 to disable clear text output

Return Value

The ClearText method returns one of the following values:

• The existing clear text flag value (0 or 1) if no argument is specified
• The new clear text flag value if an argument is passed to the method

Remarks

This flag determines whether to export passwords and shared secrets as encrypted data or as clear text. Administrator privileges are required to enable this flag.

Exporting encrypted data as clear text is required when exporting data for a target policy store with different encryption keys than the source policy store.

When you create a data manager object with the PolicyMgtSession‑>CreateDataManager method, this flag is initialized to 0 (do not output in clear text).

To set the clear text flag, call this method before calling the PolicyMgtDataMgr‑>Export method for the object. For a given instance of the data manager, a flag maintains its setting unless you reset it.