SetRamBlockStatus

Set Ram Block Status

Set Ram Block Status

Description

This request sets a block’s status to valid/changed and also to unchanged. Setting BlockChanged to True will mark it for writing during NvM_WriteAll, which is called during shutdown. The data saved is the current value in the PIM defined for the NvM block. If the value of BlockChanged is set to false before shutdown, then the block will not be updated.

Request Type

Asynchronous
If CRC calculation is updating during operation.
Synchronous
If CRC calculation is updated only at shutdown.

Port Description

The following table describes the ports for this block.

Port

Type

Description

BlockChanged

Input

Boolean value to queue the NvM update during shutdown.

Return

Output

Standard return E_OK or E_NOT_OK for the function call.
Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter

Description

NvM Block Name

The block name defined in the m-file with the NVM class.

Cast Function Return to Void

True: Function will be cast as a 'void' function and the return value is ignored.
False: Value is returned and used by the calling function.

Data Store for BlockChanged

Data store name for use in model testing for the input argument in the function call.

Data Store for Return

Data store name for use in model testing for the result of the function call.
Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type

Compatible

Native

Yes

Redundant

Yes

Data Set

Yes

See Also

Last modified October 12, 2025: Initial commit (1fadfc4)