EsbGetString

Gets a string of data from the active database.

Syntax

EsbGetString (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 a returned data string. Should be at least as large as the largest string generated by the server. Maximum string size: 256 KB.
szString	Size of the buffer to receive a returned data string.

Notes

This function should be called after EsbReport(), EsbEndReport(), or EsbQueryDatabaseMember() if data is being returned.
This function must be called repeatedly until it returns an empty string, which indicates that there is no more data to be returned.
Always include the carriage return/line feed with this command or errors will result.
Calling this function other than after successfully executing a report generates an error.
The returned string will be less than 64 KB long.
If getString length is greater than buffer size, the string is truncated.
If the returned string is less than 256 bytes the remaining empty bytes are filled with NULL characters.

Return Value

A data string is returned in getString. The function returns an empty string buffer if there is no more data to be returned.

Access

This function requires no special privileges.

Example

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