Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

SetCurrentModel
  • OpenProject.

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

Examples

None

Related Items

CreateAlias, RemoveAllAlias

Modules

import RtlabApi