|
MLPIRESULT | mlpiParameterReadMinimumChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data) |
|
MLPIRESULT | mlpiParameterReadMinimumUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data) |
|
MLPIRESULT | mlpiParameterReadMinimumShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data) |
|
MLPIRESULT | mlpiParameterReadMinimumUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data) |
|
MLPIRESULT | mlpiParameterReadMinimumLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data) |
|
MLPIRESULT | mlpiParameterReadMinimumUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data) |
|
MLPIRESULT | mlpiParameterReadMinimumLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data) |
|
MLPIRESULT | mlpiParameterReadMinimumUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data) |
|
MLPIRESULT | mlpiParameterReadMinimumFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data) |
|
MLPIRESULT | mlpiParameterReadMinimumDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data) |
|
MLPIRESULT | mlpiParameterReadMinimumString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet) |
|
This function reads the minimum value of a parameter.
The minimum is part of a parameter (Parameter structure, sercos element 5).
This function reads the 8-bit signed minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'C-0-0081'.
3 MLPIRESULT result = mlpiParameterReadMinimumChar(connection, 1, MLPI_SIDN_C(81), &data);
This function reads the 8-bit unsigned minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'C-0-0081'.
3 MLPIRESULT result = mlpiParameterReadMinimumUchar(connection, 1, MLPI_SIDN_C(81), &data);
This function reads the 16-bit signed minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'A-0-0058' of axis '1'.
3 MLPIRESULT result = mlpiParameterReadMinimumShort(connection, 1, MLPI_SIDN_A(58), &data);
This function reads the 16-bit unsigned minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'C-0-0450'.
3 MLPIRESULT result = mlpiParameterReadMinimumUshort(connection, 0, MLPI_SIDN_C(450), &data);
This function reads the 32-bit signed minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'M-0-0201' of touch probe '1'.
3 MLPIRESULT result = mlpiParameterReadMinimumLong(connection, 1, MLPI_SIDN_M(201), &data);
This function reads the 32-bit unsigned minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'C-0-0400'.
3 MLPIRESULT result = mlpiParameterReadMinimumUlong(connection, 0, MLPI_SIDN_C(400), &data);
This function reads the 64-bit signed minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'M-0-0141' of touch probe '1'.
2 // Note: The result should be an error because this parameter has no minimum value.
4 MLPIRESULT result = mlpiParameterReadMinimumLlong(connection, 1, MLPI_SIDN_M(141), &data);
This function reads the 64-bit unsigned minimum value of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'M-0-0141' of touch probe '1'.
2 // Note: The result should be an error because this parameter has no minimum value.
4 MLPIRESULT result = mlpiParameterReadMinimumUllong(connection, 1, MLPI_SIDN_M(141), &data);
This function reads the 32-bit floating point minimum value (single precision) of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to access. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'C-0-0418'.
3 MLPIRESULT result = mlpiParameterReadMinimumFloat(connection, 0, MLPI_SIDN_C(418), &data);
This function reads the 64-bit floating point minimum value (double precision) of a parameter.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'A-0-0045' of axis '1'.
3 MLPIRESULT result = mlpiParameterReadMinimumDouble(connection, 1, MLPI_SIDN_A(45), &data);
This function reads the minimum value of a parameter and returns it as String. A conversion is done automatically.
- Parameters
-
[in] | connection | Handle for multiple connections. |
[in] | address | Address identifying the object to be accessed. Use macro MLPI_ADDRESS_x to generate an address field. |
[in] | sidn | ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID. |
[out] | data | Pointer to variable where the minimum value will be stored in UTF16 format (string). |
[in] | numElements | Number of WCHAR16 elements in 'data' available to read. |
[out] | numElementsRet | Number of WCHAR16 elements in complete 'data'. |
- Returns
- Return value indicating success (>=0) or error (<0).
- Example:
1 // Read the minimum value of parameter 'A-0-0045' of axis '1'.
2 WCHAR16 data[512] = L"";
3 ULONG numElementsRet = 0;
4 MLPIRESULT result = mlpiParameterReadMinimumString(connection, 1, MLPI_SIDN_A(45), data, _countof(data), &numElementsRet);