ARExecuteProcess

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Performs the indicated command on the specified server. Depending on the values that you specify for the returnStatus and returnString parameters, you can execute the command as an independent process or wait for the process to complete and return the result to the client. The system executes the command based on the access privileges of the user who launched the AR System server.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"

int ARExecuteProcess(
  ARControlStruct *control,
  char *command,
  int *returnStatus,
  char **returnString,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

command

The command to be executed (must be a valid command on the specified server).

Return values

returnStatus

An integer that specifies the status of the operation. A value of 0 generally indicates success. Any other value generally indicates a failure.
Specify NULL for this parameter and the returnString parameter if you want the system to launch an independent process and not wait for it to complete. Else, specify a value for this parameter if you want the system to wait for the process to complete before returning. If the process does not complete within the time-out interval, adjust the filter process time-out interval to prevent the server from getting blocked.
For information about the process time-out interval, see Setting-timeout-options.

returnString

A string containing the process output. Depending on the outcome of the operation, this string contains either result data or an error message.
Specify NULL for this parameter and the returnStatus parameter if you want the system to launch an independent process and not wait for it to complete. Else, specify a value for this parameter if you want the system to wait for the process to complete before returning. If the process does not complete within the time-out interval, adjust the filter process time-out interval to prevent the server from getting blocked (configurable from 1 to 20 seconds).

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.