beautypg.com

Encode – Visara Master Console Center Scripting Guide User Manual

Page 95

background image

Chapter 5 Script Commands

Scripting Guide

95

ENCODE

Syntax:

ENCODE ($String[,$Key]) ==> $Result

Description:

Encodes a GCL string, for example, a password.

Action:

The specified string is encoded using the specified key, if any. If no key

is specified, a default key is used. The encoded output string has the
same length as the input string.

Parameters:

$String. String expression. The input string to encode.
$Key. String expression. Optional. The encoding key to use.

Returns:

$Result. String expression. The encoded output string.

Notes:

The input string must contain only printable ASCII characters, from

space to ~. If it contains unprintable characters (for example, control

characters), $Result contains an empty string and an error message is
logged in icsexec.log.

Example:

$a := "kdfjdkfj dkf@#%"
$b := encode($a)

See Also:

DECODE