ProcScript: Struct Functions
Struct functions enable you to get information about a Struct (such as the number of members it has), get or set Struct annotations, or perform actions such as inserting and moving Struct members. Syntactically, they are treated as Struct members and are accessed using the de-reference operator (->). However, they are not part of the Struct member list and they do not have an index.
Syntax
Struct->StructFunction
Context
- Struct—a variable or
parameter of type struct or any that references a Struct. If
Struct does not refer to a Struct, it returns error
-84in $procerror. - StructFunction—predefined
pseudo-member of a Struct; the function name always begins with a dollar sign $.
Unlike other functions, they do not use parentheses
().
Errors
|
Value |
Error Constant |
Meaning |
|---|---|---|
-84
|
UACTERR_NO_OBJECT
|
Struct refers to zero Structs |
-1151
|
USTRUCTERR_NO_COMMON_CHARACTERISTICS
|
Collection of Structs that do not share a common parent or the specified characteristic |
-1157
|
USTRUCTERR_ILLEGAL_MEMBER_TYPE
|
Not a valid Struct member type |
