ct_send_params

Send command parameters in batches.

Syntax

CS_RETCODE ct_send_params(
  CS_COMMAND *cmd, 
  CS_INT reserved)

Parameters

  • cmd

    A pointer to a CS_COMMAND structure.

  • reserved

    Set to CS_UNUSED. This is a placeholder reserved for possible future use.

Return value

ct_send_params returns:

Returns

Indicates

CS_SUCCEED

The routine completed successfully.

CS_FAIL

The routine failed.

Usage

A call to this function sends the parameters indicated earlier using ct_param() or ct_setparam(). To stop sending parameters, use a ct_send() call after the last ct_send_params() call. This signals the end of the parameters and completes the current command.

  • The first ct_send_params() call sends the actual command, the parameter formats for all parameters, and the first set of parameters to the server. Subsequent calls only send more parameters without format.

  • The network buffer containing the parameters gets flushed during every call to ct_send_params() so that the server can start processing the command.

  • Unlike ct_send(), ct_send_params() does not end the current command. You can call ct_send_params() repeatedly to send multiple sets of parameters.

  • The handling of the results starts only after a ct_send() call to complete the command. If ct_results() is called before ct_send(), an error results.