GetCharValue method

Builder Syntax	int __fastcall GetCharValue(Cardinal uIndex, Cardinal uCount);
Delphi Syntax	function GetCharValue(uIndex, uCount: Cardinal): Integer;
Overview	Refer to Working with Data Sets.

Remarks

Updates the CharValues property with the character value(s) associated with the item specified in the CurrentElement property. This method also updates the CharValueCount property to uCount, where uCount is the number of characters to get.

If you call this method with uCount greater than the number of characters in the Value Field of the specified item, this method will return an error. For example, if there are only three characters in the Value Field and you call this method with uCount set to four, an error will be returned.

If you have more than one value stored in the Value Field of the specified Data Element, you can retrieve one or more of those elements. For example, if the Value Field of the specified Data Element contains three character values, and you are only interested in retrieving the last two character values, set uIndex to 1 and uCount to 2. This tells the method to retrieve the character values starting at position 1 (the index is zero based) and retrieve two values. Therefore you would retrieve the values in positions 1 and 2 in the Value Field.

This method can be called only if the Value Representation of the Data Element is VR_OB, VR_SQ, or VR_UN. For more information about Value Representations, refer to Default Value Representation Table.