C-API | OP_ALIAS_INFO

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.

C-API | OP_ALIAS_INFO

Description

Defines the structure of information for an alias.

Usage

typedef struct OP_ALIAS_INFO{

char *aliasName;

char *referencePath;

OP_OBJECT_TYPE refType;

char readOnly;

OP_SEARCH_RESULTS exist;

struct OP_ALIAS_INFO *newAlias;

} OP_ALIAS_INFO;

Elements

  • aliasName: Alias' name.

  • referencePath: Absolute path of the parameter or signal referenced by the alias. This path must exist in the model.

  • referenceType: See OP_OBJECT_TYPE.

  • readOnly: Boolean: true means that the alias is readonly (cannot modify the value of the reference).

  • exist: See OP_SEARCH_RESULTS. This field is only setted when the structure is obtained from the OpalLoadAliasDescription function.

  • newAlias: Pointer to new estimated alias if the alias doesn't exist in the current model. This field is only set when the structure is obtained from the OpalLoadAliasDescription function.

Examples

None.

Related Items

OpalGetAliasDescription, OpalLoadAliasDescription, OP_SEARCH_RESULTS, OP_OBJECT_TYPE.

Library and Header



WINDOWS

LINUX

Static Library

OpalApi.lib

-

Dynamic Library

OPalApi.dll

libOpalApi.so

Header File

OpalApi.h

OpalApi.h