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.

GetAliasDescription

Group

Model Interaction, Alias

Description

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

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

Examples

None

Related Items

CreateAlias, LoadAliasDescription, OP_ALIAS_INFO

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
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter