<< Previous | Next >>

_GetSysMacroValue

int _GetSysMacroValue( char * name, long * value );

Description

Finds the system table macro named by the first parameter (as defined by the compiler) and retrieves the value of the macro as defined in the system macro table. The system macro table contains board specific configuration parameters that are define by the compiler and can be retrieved at runtime through this interface. The flash driver must be initialized and the System ID block must be read before this function will return accurate results.

See writeUserBlockArray for more details.

This function only applies to boards with Version 5 or later System ID blocks.

Parameters

name

Name of System ID block macro (acts as lookup key).

value

Pointer to macro value to return to caller.

Return Value

 0: if successful
-1: Macro name not found
-2: No valid ID block found (block version 3 or later)
-3: First parameter is a bad macro name

Library

IDBLOCK.LIB

See Also

writeUserBlockArray