clibgen.FunctionTypeDefinition Class

R2026b

Namespace: clibgen

(Not recommended) Definition for MATLAB function type corresponding to C++ function type

The recommended way to generate a function type for a C++ library is to use a clibgen.api.FunctionTypeDefinition object. For more information on updating your code, see Version History.

Description

Use a FunctionTypeDefinition object to represent function types std::function and C function pointer arguments in the C++ library.

The clibgen.FunctionTypeDefinition class is a handle class.

Creation

MATLAB^® constructs a FunctionTypeDefinition object when MATLAB calls addFunctionType on a clibgen.LibraryDefinition object.

Properties

Description — Help text

string | character vector

Help text for the end user describing the function type, specified as a string or a character vector. The publisher can modify the value of the Description property in the library definition file.

Attributes:

GetAccess	public
SetAccess	public

CPPSignature — Function type signature

string | character vector

Function type signature, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

MATLABName — Function type name in MATLAB

string | character vector

Function type name in MATLAB, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

DefiningLibrary — Library defining class

clibgen.LibraryDefinition

Library defining the function type, specified as a clibgen.LibraryDefinition object.

Attributes:

GetAccess	public
SetAccess	private

Version History

Introduced in R2021a

R2026b: Not recommended

There are no plans to remove clibgen.FunctionTypeDefinition. However, creating a clibgen.api.FunctionTypeDefinition object in the clibgen.api namespace is recommended instead.