OutputDebugString

Description

Specifies a message that can be displayed by a debugger or a similar tool.

The argument value of this method is passed to the Win32 API call OutputDebugString. Various tools like debuggers and Purify® can detect this call and report the content of the string. Normally, the debug message is invisible to users.

The Windows™ debugging utility dbwin32.exe is included with HCL Compass. It is located in the HCL Compass installation directory. When dbwin32.exe is active, it displays all the messages generated by OutputDebugString.

After you start dbwin32.exe, insert the OutputDebugString method wherever you want to have a text string output in your hook code. Then, execute the hook or script you created or modified. After executing the hook, use the information in the DBWIN32 console to assess whether you have a bug and how to correct it.

Syntax

VBScript

session.OutputDebugString debugString 

Perl

$session->OutputDebugString(debugString); 

Identifier

Description

session

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

debugString

A String containing the text to be displayed.

Return value

None.

Examples

VBScript

set sessionObj = GetSession 
sessionObj.OutputDebugString "This is a test message." 

Perl

#Get a HCL Compass session

$sessionObj = $entity->GetSession();



#Display a debug string via a debugger 

$sessionObj->OutputDebugString("This is a test message.");