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.

RemoveAlias

Owned by Sylvain Ménard
Last updated: May 17, 2023
1 min read

Group

Model Interaction, Alias

Description

Remove aliases from the current list of aliases currently associated with the active model.

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

Required Control

System control

Usage

RtlabApi.RemoveAlias(aliasNamePattern)

Input

  • aliasNamePattern: See Glossary.

Output

None

Exception

  • EOK: Success.

  • EPERM: Configuration control has not been granted to this client.

  • EINVAL: Alias not found.

  • EBADF: Model not specified by previous Connect or OpenProject.

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

Examples

None

Related Items

CreateAlias, RemoveAllAlias

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