Versions Compared

Key

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

Group

Model Interaction, Alias

Description

Returns

Return the set of information of aliases active for the current model.

Specifying a pattern ensures that only matching alias information is returned. Wildcard characters (?,*) may be used in pattern.

Required Control

None

Usage

aliasInfo = RtlabApi.GetAliasDescription(aliasNamePattern)

Input

  • aliasNamePattern: see Glossary.

Output

  • aliasInfo: List of aliases' tuple returned. See OP_ALIAS_INFO

Exception

  • EOK: Success.

  • ENOMEM: Memory allocation error.

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

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • EINVAL: Alias with the specified path is not found.

Examples

None

Related Items

CreateAlias, LoadAliasDescription, OP_ALIAS_INFO

Modules

import RtlabApi