dtssStringGetText Function

Get the text of a string represented by a dtsStringHandle

long DLLFUNC dtssStringGetText(dtsStringHandle hStr, char * buf, long bufferSize);

File

dtsearch.h

Parameters

Parameters	Description
dtsStringHandle hStr	Handle to the string
char * buf	Buffer to receive the text
long bufferSize	Size of the buffer, in bytes

Returns

Length of the string

Remarks

Use dtssStringGetLength() to get the length of the string, to make sure the buffer is large enough.

dtsStringHandles are used to return variable-length string values from certain dtSearch Engine API functions. After retrieving the text of the string, the caller must use dtssStringDelete to free the memory that was allocated for the string.