SetBasicReturnStringMode

Description

Specifies the return string mode for how Strings are to be returned for VBScript hooks and scripts.

The return string mode setting does not alter the format of a returned String. If the return string mode is set to AD_RETURN_STRING_LOCAL and if a character in the returned string is not in the local character set, an exception is thrown. Exceptions can be checked with the "On Error" and "Err.description" utilities. See Error checking and validation for more information.

Syntax

VBScript

session.SetBasicReturnStringMode mode 

Identifier

Description

session

The Session object that represents the current database-access session.

mode

A Long containing an Return string mode enumerated constant.

Return value

None.

Example

VBScript

    Dim session As Object
    Set session = CreateObject("CLEARQUEST.SESSION")
    Dim savedMode
    savedMode= session.GetBasicReturnStringMode()
    session.SetBasicReturnStringMode(AD_RETURN_STRING_LOCAL)
    ' Do something that requires LOCAL mode:
    .....
    session.SetBasicReturnStringMode(AD_RETURN_STRING_UNICODE)
    ' Do something that requires UNICODE mode: 
    ....
    ' Restore the original mode
    session.SetBasicReturnStringMode(savedMode)