Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Group

Model Interaction, Alias
Description

Returns 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.
  • EINVAL: Alias with the specified path is not found.
ExamplesNone
Related ItemsCreateAlias, LoadAliasDescription, OP_ALIAS_INFO
Modulesimport RtlabApi
  • No labels