IDL_RPCOutputGetStr

Calling Sequence

int IDL_RPCOutputGetStr(CLIENT *pClient,  IDL_RPC_LINE_S *pLine, 
    int first)

Description

Use this function to get an output line from the line queue being maintained on the RPC server. The routine IDL_RPCOutputCapture() must have been called to initialize the output queue on the RPC server before this routine is called.

Parameters

pClient

A pointer to the CLIENT structure that corresponds to the desired IDL session.

pLine

A pointer to a valid IDL_RPC_LINE_S structure. The buf field of this structure will contain the output string returned from the IDL RPC server and the flags field will be set to one of the following (from idl_export.h):

IDL_TOUT_F_STDERR — Send the text to stderr rather than stdout, if that distinction means anything to your output device.

IDL_TOUT_F_NLPOST — After outputting the text, start a new output line. On a tty, this is equivalent to sending a new line (`\n) character.

first

If first is set equal to a non-zero value, the first line is popped from the output buffer on the IDL RPC server (the output buffer is treated like a stack). If first is set equal to zero, the last line is de-queued from the output buffer (the output buffer is treated like a queue).

Return value

A true value (1) is returned upon success. A false value (0) is returned when there are no more lines available in the output buffer or when an RPC error is detected.