activePDF Toolkit 2011 API Reference
Val_GetString
Technical Reference > Explorer Object > Methods > Val_GetString

Glossary Item Box

Description: Returns the string of characters for an object attributes value known to represent a String object.
Syntax: "retValue" = object.Val_GetString (AttrVariant)
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the Explorer object.
AttrVariant Integer An encoded value representing the input object's attributes as returned by the Dict_GetAttrVal, Dict_GetValue, Obj_AttrVal, Val_GetFirstElem, or Val_GetNextElem method known to be a String object as verified by the Val_IsString method.
retValue: Value Type Description & Settings
String The string of characters contained in the String object corresponding to the AttrVariant. Hexadecimal strings are suitable for passing as the Val_DecodePDFString method HexString. The method returns an empty string ("") if the string is empty or if the AttrVariant is invalid.