Functions: Commands

Functions for creating, parameterizing, and executing commands.

eplCreateCommand

EplHandle
eplCreateCommand (EplSession     s,
                  const EplChar* name);

Using this function, a command is created. After successful execution of the function, a command handle is returned. Using this handle, the parameters of the command can be transferred (eplSetParam and eplSetHandleParam) and the return values be queried (eplGetHandleParam and eplGetParam).

Return Description
EplHandle Handle of the generated command or EPL_ERROR if the generation of the command fails. Using this handle, the parameters are transferred and the command is executed.

eplSetHandleParam
eplSetParam
eplExecuteCommand
Input Type Description
s EplSession Handle of an opened session.
name const EplChar* Name of the command to be generated.

eplExecuteCommand

EplHandle
eplExecuteCommand (EplSession s,
                   EplHandle  command);

Using this function, the command is executed. The parameters of the command must have been previously transferred via eplSetHandleParam and eplSetParam.

Return Description
EplHandle EPL_OK if execution of the command was successful or EPL_ERROR if execution of the command failed.
Input Type Description
s EplSession Handle of an opened session.
command EplHandle Handle of the command which was previously created via the eplCreateCommand function.

eplSetParam

EplHandle
eplSetParam (EplSession     s,
             EplHandle            command,
             EplProperty    param,
             const EplChar* val,
             EplIndex       idx);

Sets the value of a parameter for a command. The value is transferred as character string. The parameters can be of the "indexed" type.

Return Description
EplHandle The function returns EPL_OK if the parameter could be successfully set. If the function fails, EPL_ERROR is returned.
Input Type Description
s EplSession Handle of an opened session.
command EplHandle Handle of the command which was previously created via the eplCreateCommand function.
param EplProperty ID of the parameter to be set.
val const EplChar* Character string representing the value of the parameter to be transferred.
idx EplIndex Index of the parameter. In the case of non-indexed parameters, the index is set to 0. In the case of indexed parameters, the system starts with index value 1.

eplSetHandleParam

EplHandle
eplSetHandleParam (EplSession        s,
                   EplHandle            command,
                   EplProperty    param,
                   EplHandle        val,
                   EplIndex       idx);

Sets the value of a handle parameter for a command. The value is the handle of an object which has been determined via other commands or iterators. This value is transferred as EplHandle.
The parameters can be of the "indexed" type.

Return Description
EplHandle The function returns EPL_OK if the parameter could be successfully set. If the function fails, EPL_ERROR is returned.
Input Type Description
s EplSession Handle of an opened session.
command EplHandle Handle of the command which was previously created via the eplCreateCommand function.
param EplProperty ID of the parameter to be set.
val EplHandle Handle of the object to be set as parameter.
idx EplIndex Index of the parameter. In the case of non-indexed parameters, the index is set to 0. In the case of indexed parameters, the system starts with index value 1.

eplGetParam

EplHandle
eplGetParam (EplSession         s,
             EplHandle            command,
             EplProperty    param,
             EplIndex         idx,
             EplChar*         buf,
             EplSize         buflen);

The eplGetParam function queries the value of a parameter. The parameters can be of the "indexed" type.

Return Description
EplHandle The function returns EPL_OK if the parameter could be successfully used. If the function fails, EPL_ERROR is returned.
Input Type Description
s EplSession Handle of an opened session.
command EplHandle Handle of the command whose parameter is queried.
param EplProperty ID of the parameter to be queried.
idx EplIndex Index of the parameter. In the case of non-indexed parameters, the index is set to 0. In the case of indexed parameters, the system starts with index value 1.
buf EplChar* If the command parameter could be successfully queried, buf will contain the parameter value as character string.
buflen EplSize Indicates the length of the buffer buf.

eplGetHandleParam

EplHandle
eplGetHandleParam (EplSession        s,
                   EplHandle            command,
                   EplProperty    param,
                   EplIndex       idx);

eplGetHandleParam is used to query a command for a parameter of the EplHandle type. The handle must be released again by the user!

Return Description
EplHandle The function returns EPL_OK if the parameter could be successfully queried. If the function fails, EPL_ERROR is returned.
Input Type Description
s EplSession Handle of an opened session.
command EplHandle Handle of the command whose parameter is queried.
param EplProperty ID of the parameter to be queried.
idx EplIndex Index of the parameter. In the case of non-indexed parameters, the index is set to 0. In the case of indexed parameters, the system starts with index value 1.