You are here: C++ API > Functions > dtssStringGetText Function
Close
dtSearch Text Retrieval Engine Programmer's Reference
ContentsContentsIndexIndexHomeHome
PreviousUpNext
dtssStringGetText Function
Collapse AllCollapse AllExpand AllExpand All

File: dtsearch.h

Syntax
C++
long DLLFUNC dtssStringGetText(dtsStringHandle hStr, char * buf, long bufferSize);
Parameters
Description
dtsStringHandle hStr
Handle to the string
char * buf
Buffer to receive the text
long bufferSize
Size of the buffer, in bytes

Length of the string

Get the text of a string represented by a dtsStringHandle

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.

Copyright (c) 1995-2023 dtSearch Corp. All rights reserved.
ContentsIndexHome