Versions Compared

Key

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

Group

Generic

Description

Set the values of some object attributes.

See the OP_ATTRIBUTE enumeration for a complete list of available attributes.

Required Control

Depending on the attribute types and the object types. See OP_ATTRIBUTE for more information on the required controls.

Usage

rtlabApi.SetAttributes (ids, attributes, attributeValues)


ids = (OP_REF, ...)

attributes = (OP_ATTRIBUTE, ...)

attributeValues = (value1, ...)

Input

  • ids: Tuple of object ids on

witch
  • which the GetAttributes function will act. The size of the array must be equal to size of attributes tuple.

  • attributes: Tuple of attributes to get on the corresponding objects specified with the ids argument. The size of the array must be equal to size of attributes tuple.

  • attributesValues: Tuple of values corresponding to each object ids and attributes.

Output

None

Exception

  • EOK: Success.

  • EINVAL: Invalid arguments specified.

  • EBADF: Model not specified by previous

OpalConnect
  • Connect or

OpalSetCurrentModel
  • OpenProject.

  • EIO: Error sending the request or receiving the reply.

  • EPERM: Required control had not been granted to this client to change the attribute.

Examples

None

Related Items

GetAttributes, GetDefaultAttributes, RestoreAttributes, OP_ATTRIBUTE.

Modules

import RtlabApi