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

Load a list of aliases. The new list isn’t merged to the current list of aliases or doesn’t replace the current list of aliases.

Specifying a pattern ensures that only maching aliases information is returned. Wildcard characters (?,*) may by used in pattern.

The exist field of the aliasInfo structure indicates if the loaded alias matchs an alias in the current list of alias. When a match exists, the newAlias field of the aliasInfo structure contains a pointer of the matched alias.

Required Control

None
Usage

aliasInfo = RtlabApi.LoadAliasDescription(fileName, aliasNamePattern)

(aliasInfo1, aliasInfo2, ...) = aliasInfo

(aliasName, referencePath, referenceType, readOnly, exist, newAlias) = aliasInfo1

Input
  • fileName: Absolute or relative path of the file to load.
  • aliasNamePattern: See Glossary.
Output
  • aliasInfo: Tuple of information for a list of alias. See OP_ALIAS_INFO.
Exception
  • EOK: Success.
  • ENOENT: Cannot open parameter file.
  • EIO: Error sending the request or receiving the reply.
  • EBADF: Model not specified by previous Connect or SetCurrentModel.
  • ENOMEM: Memory allocation error.
ExamplesNone
Related ItemsCreateAlias, LoadAlias, SaveAlias, GetAliasDescription.
Modulesimport RtlabApi
  • No labels