GetBasicReturnStringMode

Description

Returns the return string mode for how Strings are returned for VBScript hooks and scripts. Returns either AD_RETURN_STRING_UNICODE or AD_RETURN_STRING_LOCAL.

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.GetBasicReturnStringMode 

Identifier

Description

session

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

Return value

Returns a Long containing an Return strong mode enumerated constant.

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)