ssGetDataTypeZero

Get the zero representation of a data type

Syntax

void *ssGetDataTypeZero(SimStruct *S, DTypeId id)

Arguments

S

SimStruct that represents an S-Function block.

id

ID of a data type.

Returns

A pointer (void *) to the zero representation of the data type specified by id, if id is valid and the data type's size has been set. Otherwise, returns NULL and reports an error.

Description

Use to obtain the zero representation of a data type, which is the value that represents zero for the custom data type.

Note

Because this macro reports any error that occurs, you do not need to use ssSetErrorStatus to report the error.

For more information about using custom data types in S-functions, see Configure Custom Data Types.

Languages

C, C++

Examples

The following example gets the zero representation of a custom data type.

const void *myZero = ssGetDataTypeZero(S, id);
if(myZero == NULL) return;