Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
Functions
Maximum
ParameterLib » Minimum, Maximum
Collaboration diagram for Maximum:

Functions

MLPIRESULT mlpiParameterReadMaximumChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data)
 
MLPIRESULT mlpiParameterReadMaximumUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data)
 
MLPIRESULT mlpiParameterReadMaximumShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
 
MLPIRESULT mlpiParameterReadMaximumUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
 
MLPIRESULT mlpiParameterReadMaximumLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
 
MLPIRESULT mlpiParameterReadMaximumUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
 
MLPIRESULT mlpiParameterReadMaximumLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
 
MLPIRESULT mlpiParameterReadMaximumUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
 
MLPIRESULT mlpiParameterReadMaximumFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
 
MLPIRESULT mlpiParameterReadMaximumDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
 
MLPIRESULT mlpiParameterReadMaximumString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
 

Detailed Description

This function reads the maximum value of a parameter.

The maximum is part of a parameter (Parameter structure, sercos element 6).

Function Documentation

MLPIRESULT mlpiParameterReadMaximumChar ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
CHAR *  data 
)

This function reads the 8-bit signed maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'C-0-0081'.
2 CHAR data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumChar(connection, 1, MLPI_SIDN_A(58), &data);
MLPIRESULT mlpiParameterReadMaximumUchar ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
UCHAR *  data 
)

This function reads the 8-bit unsigned maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'C-0-0081'.
2 UCHAR data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumUchar(connection, 1, MLPI_SIDN_A(58), &data);
MLPIRESULT mlpiParameterReadMaximumShort ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
SHORT *  data 
)

This function reads the 16-bit signed maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'A-0-0058' of axis '1'.
2 SHORT data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumShort(connection, 1, MLPI_SIDN_A(58), &data);
MLPIRESULT mlpiParameterReadMaximumUshort ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
USHORT *  data 
)

This function reads the 16-bit unsigned maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'C-0-0450'.
2 USHORT data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumUshort(connection, 0, MLPI_SIDN_C(450), &data);
MLPIRESULT mlpiParameterReadMaximumLong ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
LONG *  data 
)

This function reads the 32-bit signed maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'M-0-0201' of touch probe '1'.
2 LONG data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumLong(connection, 1, MLPI_SIDN_M(201), &data);
MLPIRESULT mlpiParameterReadMaximumUlong ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
ULONG *  data 
)

This function reads the 32-bit unsigned maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'C-0-0400'.
2 ULONG data = 0;
3 MLPIRESULT result = mlpiParameterReadMaximumUlong(connection, 0, MLPI_SIDN_C(400), &data);
MLPIRESULT mlpiParameterReadMaximumLlong ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
LLONG *  data 
)

This function reads the 64-bit signed maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'M-0-0141' of touch probe '1'.
2 // Note: The result should be an error because this parameter has no maximum value.
3 LLONG data = 0;
4 MLPIRESULT result = mlpiParameterReadMaximumLlong(connection, 1, MLPI_SIDN_M(141), &data);
MLPIRESULT mlpiParameterReadMaximumUllong ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
ULLONG *  data 
)

This function reads the 64-bit unsigned maximum value of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'M-0-0141' of touch probe '1'.
2 // Note: The result should be an error because this parameter has no maximum value.
3 ULLONG data = 0;
4 MLPIRESULT result = mlpiParameterReadMaximumUllong(connection, 1, MLPI_SIDN_M(141), &data);
MLPIRESULT mlpiParameterReadMaximumFloat ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
FLOAT *  data 
)

This function reads the 32-bit floating point maximum value (single precision) of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'C-0-0418'.
2 FLOAT data = 0.0;
3 MLPIRESULT result = mlpiParameterReadMaximumFloat(connection, 0, MLPI_SIDN_C(418), &data);
MLPIRESULT mlpiParameterReadMaximumDouble ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
DOUBLE *  data 
)

This function reads the 64-bit floating point maximum value (double precision) of a parameter.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'A-0-0045' of axis '1'.
2 DOUBLE data = 0.0;
3 MLPIRESULT result = mlpiParameterReadMaximumDouble(connection, 1, MLPI_SIDN_A(45), &data);
MLPIRESULT mlpiParameterReadMaximumString ( const MLPIHANDLE  connection,
const ULLONG  address,
const ULLONG  sidn,
WCHAR16 *  data,
const ULONG  numElements,
ULONG *  numElementsRet 
)

This function reads the maximum value of a parameter and returns it as UTF16 String. A conversion is done automatically.

Parameters
[in]connectionHandle for multiple connections.
[in]addressAddress identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field.
[in]sidnID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
[out]dataPointer to variable where the maximum value will be stored in UTF16 format (string).
[in]numElementsNumber of WCHAR16 elements in 'data' available to read.
[out]numElementsRetNumber of WCHAR16 elements in complete 'data'.
Returns
Return value indicating success (>=0) or error (<0).
Example:
1 // Read the maximum value of parameter 'A-0-0045' of axis '1'.
2 WCHAR16 data[512] = L"";
3 ULONG numElementsRet = 0;
4 MLPIRESULT result = mlpiParameterReadMaximumString(connection, 1, MLPI_SIDN_A(45), data, _countof(data), &numElementsRet);