Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GetObjectParam method returns the value of the specified parameter of the system object at the moment of method call invocation.Method call syntax

Syntax for method invocation:

Code Block
languagejavascript
 function  GetObjectParam(objtype : String, id : String, param : String) : String

Method arguments:

  1. objtype - Required is a required argument. The It specifies the type of the object whose parameter’s value is to be returned. It takes the following values:  Type – String, range – existing object types.
  2. id - Required argument. Identification number of the object of the type set in the objtype argument. It takes the following values:  Type – String, range – existing identification numbers of the objects of the specified type.
  3. param - Required argument. The name of the parameter whose value is to be returned. It takes the following values:  Type – String, range – available parameters of the object.

Usage examples

  1. system object for which you want to return the value of the specified parameter. Possible values: String type, range is limited by object types registered in the system.
  2. id is a required argument. It corresponds to the identification (registration) number of the object specified by the objtype argument. Possible values: String type, the range is limited by the identification numbers of objects of the specified type registered in the system.
  3. param is a required argument. It corresponds to the name of the parameter the value of which you want to return. Possible values: String type, range is limited by the parameters available for the given object.

Example. See the example in The See the example for the SetObjectParam method.