Documentation

xPCGetParam

Get parameter value and copy it to array

Prototype

void xPCGetParam(int port, int paramIndex, double *paramValue);

Arguments

port

Enter the value returned by the function xPCOpenTcpIpPort.

paramIndex

Enter the index for a parameter.

paramValue

The function returns a parameter value as an array of doubles.

Description

The xPCGetParam function returns the parameter as an array in paramValue. paramValue must be large enough to hold the parameter. You can query the size by calling the function xPCGetParamDims. Get the parameter index by calling the function xPCGetParamIdx. The parameter matrix is returned as a vector, with the conversion being done in column-major format. It is also returned as a double, regardless of the data type of the actual parameter.

For paramIndex, values range from 0 to (N-1), where N is the return value of xPCGetNumParams.

Introduced before R2006a

Was this topic helpful?