EsbGetStringBuf

Gets data from the active database until it returns all available data or until the caller's buffer is full.

Syntax

EsbGetStringBuf (hCtx, getString, szString)
ByVal hCtx      As Long
ByVal getString As String
ByVal szString  As Integer

Parameter	Description
hCtx	VB API context handle.
getString	Buffer to receive returned data strings. Maximum buffer size: 64 K.
szString	Size of buffer to receive returned data string.

Notes

Call this function after EsbReport(), EsbEndReport(), or EsbQueryDatabaseMember() if data is returned.
Calling this function other than after successfully executing a report generates an error.
This function differs from EsbGetString() in that EsbGetString() returns data one line at a time. For larger data sets use EsbGetString().

Return Value

This function returns one or more data strings in getString. If no more data is left, it returns an empty string buffer.

This function returns all the data the buffer can accommodate, even if this means taking part of a record and including this partial record at the end of the buffer. The next call to EsbGetStringBuf() returns the rest of the partial record at the start of the buffer.

Access

This function requires no special privileges.

Example

Declare Function EsbGetStringBuf Lib "ESBAPIN"(
   ByVal hCtx As Long, 
   ByVal getString As String, 
   ByVal szString As Integer) 
   As Long

See the examples for EsbReport and EsbQueryDatabaseMembers.