getGlobalArg

R2026b

Class: Simulink.CustomCode.FunctionPortSpecification
Namespace: Simulink.CustomCode

Get object definition of global variable in C Caller block

Syntax

GlobalArg = PortSpecObj.getGlobalArg(globalVariableName)

Description

GlobalArg = PortSpecObj.getGlobalArg(globalVariableName), where PortSpecObj is an object of the class FunctionPortSpecification, and creates a FunctionArgument object for the specified global argument.

Input Arguments

globalVariableName — Name of global variable

character vector | string scalar

Name of global variable, specified as a character vector or string scalar.

Data Types: char | string

Output Arguments

GlobalArg — Global argument object

FunctionArgument object

Global argument object associated with the C Caller block, returned as a FunctionArgument object.

Examples

Create Handle to Global Variable in C Caller Block

Access the properties of a global variable used in a C Caller block.

Obtain a FunctionPortSpecification object from the C Caller block (indicated as gcb) in your model using the get_param function. For example, select the block in your model canvas, and then enter the following command at the command line.

myFunctionPortSpecObject = get_param(gcb, 'FunctionPortSpecification')

Query and create a FunctionArgument object for the global argument for the global variable myGlobalVarPort. Change the global variable to the one you use in your model.

 myGlobalVariable = myFunctionPortSpecObject.getGlobalArg('myGlobalVarPort')

myGlobalVariable = 

  FunctionArgument with properties:

          Name: 'myGlobalVarPort'
    PortNumber: 1
          Size: '1'
          Type: 'double'
         Label: 'myGlobalVarPort'
         Scope: 'Input'

Version History

Introduced in R2020b