Version_Error_Read

Version and Error Information Functions. More...

Collaboration diagram for Version_Error_Read:

Functions
I32_T FNTYPE	NMC_GetLibVersion (_opt_null_ I32_T *PRetMajor, _opt_null_ I32_T *PRetMinor, _opt_null_ I32_T *PRetStage, _opt_null_ I32_T *PRetBuild)
	Return the version number of the Library: Major.Minor.Stage.Build. More...
void FNTYPE	NMC_GetLibVersionString (char *PRetVersionString, U32_T StringSize)
	Return the version number of the Library in the format of a C string: Major.Minor.Stage.Build. More...
const char *FNTYPE	NMC_GetErrorDescription (RTN_ERR ErrorCode, _opt_null_ char *PRetErrorDesc, U32_T StringSize)
	Return the error code description in the format of a C string. More...

Detailed Description

Version and Error Information Functions.

Function Documentation

const char* FNTYPE NMC_GetErrorDescription	(	RTN_ERR	ErrorCode,
		_opt_null_ char *	PRetErrorDesc,
		U32_T	StringSize
	)

Return the error code description in the format of a C string.

Parameters

ErrorCode	The error code to be inquired
PRetErrorDesc	A char array which is 512 characters at least
StringSize	The size of input char array

Returns

The error code description. It will be NULL if the ErrorCode is undefined

Usage:

Examples:

Reference:

I32_T FNTYPE NMC_GetLibVersion	(	_opt_null_ I32_T *	PRetMajor,
		_opt_null_ I32_T *	PRetMinor,
		_opt_null_ I32_T *	PRetStage,
		_opt_null_ I32_T *	PRetBuild
	)

Return the version number of the Library: Major.Minor.Stage.Build.

Parameters

[out]	PRetMajor	[Input] A pointer variable, [Output] The major version number. Input NULL(0) can ignore the parameter.
[out]	PRetMinor	[Input] A pointer variable, [Output] The minor version number. Input NULL(0) can ignore the parameter.
[out]	PRetStage	[Input] A pointer variable, [Output] The stage of version number. Input NULL(0) can ignore the parameter. The return value 1 to 4 indicate the trial versions, and the 5 indicates the official release version.
[out]	PRetBuild	[Input] A pointer variable, [Output] The build of version number. Input NULL(0) can ignore the parameter.

Returns

The version number will be returned with the data type of I32_T. The return value means: Version = (Majorx10,000,000) + (Minorx100,000) + (Stagex10,000) + Build

Examples:

U32_T version;
I32_T major, minor, stage, build;
version = NMC_GetLibVersion( &major, &minor, &stage, &build );
printf( "Library version = %d, (%d,%d,%d,%d) \n", version, major, minor, stage, build );

void FNTYPE NMC_GetLibVersionString	(	char *	PRetVersionString,
		U32_T	StringSize
	)

Return the version number of the Library in the format of a C string: Major.Minor.Stage.Build.

Parameters

PRetVersionString	A C string which is 32 characters at least
StringSize	The size of the input C String

Returns

None

Usage:

Examples:

char versionString[32];
NMC_GetLibVersionString( versionString, 32 );
printf( "Library version = (%s) \n", versionString );

Reference: