Atlas Copco PowerMACS 4000, User Manual

Page: 571 / 668

Peripheral Devices
9836 3521 01 571
8.14.4.49 GetSetupItem
Description: This method returns the value of the setup item specified by the Item string. The Item string
uses a specific syntax (see Layout of Setup Item Descriptions for a description) to point out
which parameter to read the value of. The value is always returned as a floating-point
number. Boolean parameters are converted to a Single such that zero (0) represents False
and one (1) represents True. If not connected to a System TC then
eRetCmdNotAllowed is
returned.
Return type : A RetCodeEnum value, or if in the interval [-101..-260] syntax errors in the Item string. In
case of syntax error then ABS(return value) - 100 is equal to the position in the string of the
first error. Example: Return value -120 corresponds to a syntax error near character 20.
Syntax: object . GetSetupItem ( Item, Value )
Obj./Arg. Type Dir Description
object Api The Api object to operate on.
Item String In The string specifying which parameter to read, see Layout of
Setup Item Descriptions.
Value Single Out The value of the read parameter.
8.14.4.50 SetSetupItem
Description: This method sets the value of the setup item specified by the Item string. The Item string
uses a specific syntax (see Layout of Setup Item Descriptions for a description) to point out
which parameter to write to. The value must be a floating-point number. For Boolean
parameters - set zero (0) if False and one (1) if True. If not connected to a System TC then
eRetCmdNotAllowed is returned.
Return type : A RetCodeEnum value, or if in the interval [-101..-260] syntax errors in the Item string. In
case of syntax error then ABS(return value) - 100 is equal to the position in the string of the
first error. Example: Return value -120 corresponds to a syntax error near character 20.
Syntax: object . SetSetupItem ( Item, Value )
Obj./Arg. Type Dir Description
object Api
The Api object to operate on.
Item String In The string specifying which parameter to write, see Layout of
Setup Item Descriptions.
Value Single In The value to write.