dtssStringGetText Function

You are here: C++ API

C++ Support Classes

Using the dtSearch Engine with C++

Using the dtSearch Engine with C++ (Linux)

Language Analyzer API

External Thesaurus API

File Parser API

Structs, Records, Enums

> dtssStringGetText Function

dtsRegisterViewer Function

dtssCheckConfiguration Function

dtssConvertFile2 Function

dtssConvertPath2 Function

dtssDebugLogEx Function

dtssDeleteIndex Function

dtssDoIndexJob Function

dtssDoSearchJob Function

dtssGetIcuStatus Function

dtssGetIndexInfo Function

dtssGetOptions Function

dtssGetIndexInfo2 Function

dtssInstallCrashDiagnostics Function

dtssGetOptions2 Function

dtssIntArrayDelete Function

dtssGetSynonyms Function

dtssIntArrayGetItems Function

dtssIntArrayGetLength Function

dtssListIndex Function

dtssIntArrayGetItemRange Function

dtssMergeIndexes Function

dtssRemoveCrashDiagnostics Function

dtssSetOptions Function

dtssStringDelete Function

dtssRestoreCrashDiagnostics Function

dtssStringGetLength Function

dtssStringGetText Function

dtssSetOptions2 Function

dtssVerifyIndex Function

dtssVersion Function

dtssUtf8Decode Function

dtssVersionEx Function

dtssUtf8Decode2 Function

dtssUtf8Encode Function

dtssUtf8Encode2 Function

Close

dtSearch Text Retrieval Engine Programmer's Reference

Contents|Index|Home

Previous|Up|Next

dtssStringGetText Function

File

File: dtsearch.h

Syntax

C++

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

Group

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

Description

Get the text of a string represented by a dtsStringHandle

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.