ValidateStringInCQDataCodePage

Description

Checks to see if characters in a given String are in the HCL Compass data code page for the schema-repository of a Session. If the String is not in the code page, it returns an error message for display to the user. The error message includes which characters (up to the first five characters) were not in the HCL Compass data code page. This function is similar to IsStringInCQDataCodePage but returns more information. IsStringInCQDataCodePage returns a True or False value, instead of an error message string.

Note: This method became available in version 2003.06.00.

Syntax

VBScript


adminSession.ValidateStringInCQDataCodePage stringToCheck 

Perl


$adminSession->ValidateStringInCQDataCodePage($stringToCheck); 
Identifier
Description
adminSession
The AdminSession object representing the current schema repository access session.
stringToCheck
A String that specifies what you are checking to see is in the HCL Compass data code page.
Return value
Returns an empty String if the stringToCheck is valid, otherwise, it returns a displayable error message

Examples

VBScript


validation = adminSession.ValidateStringInCQDataCodePage stringToCheck 

Perl


$validation = $adminSession->ValidateStringInCQDataCodePage($stringToCheck);