DecodeText method: MCFMailUtil class

Syntax

DecodeText(TextToDecode, &DecodedText)

Description

Use the DecodeText method to decode text. If you only want to decode a word, use the DecodeWord property.

The text is decoded based on the values used with the EncodeText method.

The decoded text is placed in the &DecodedText parameter.

This method returns true if successful. If the return value is false, the following MCFMailUtil properties are set accordingly:

  • ErrorDescription

  • ErrorDetails

  • ErrorMsgParamsCount

  • MessageNumber

  • MessageSetNumber

In addition you can use the GetErrorMsgParam method to return each of the substitution strings used to format the error message.

Parameters

Parameter Description

TextToDecode

Specify the text that is to be decoded, as a string.

&DecodedText

Specify a string variable, used to hold the decoded text.

Returns

A Boolean value: true if successful, false otherwise.