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.

LoadAliasDescription

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 OpenProject.

  • ENOMEM: Memory allocation error.

Examples

None

Related Items

CreateAlias, LoadAlias, SaveAlias, GetAliasDescription.

Modules

import RtlabApi

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323