Versions Compared

Key

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

Group

Model Interaction, Alias

Description

Load a list of aliases in the current list of aliases. The new list can replace the current list of aliases or it can be merged with the current list depending on the function's settings.

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

Required Control

System control

Usage

status = LoadAlias(fileName, aliasNamePattern, options)

Input

  • fileName: Absolute or relative path of the file to load.

  • aliasNamePattern: See Glossary.

  • options: Options that tells the function how to handle conflicts. See OP_LOAD_FILE_OPTION.

Output

  • status: Status of the operation. See OP_LOAD_FILE_STATUS.

Exception

  • EOK: Success.

  • ENOENT: Cannot open alias file.

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

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

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • ENOMEM: Memory allocation error.

Examples

None

Related Items

CreateAlias, RemoveAlias, SaveAlias, LoadAliasDescription, OP_LOAD_FILE_STATUS, OP_LOAD_FILE_OPTION.

Modules

import RtlabApi