ReturnCodes.cpp File Reference

Maps status messages to library return codes. More...

Functions
std::string	ITS::Propagation::LFMF::GetLibraryName ()
	Get library name.
std::string	ITS::Propagation::LFMF::GetLibraryVersion ()
	Get library version.
std::string	ITS::Propagation::LFMF::GetReturnStatus (int code)
	Get an error message string from a return code.
char *	ITS::Propagation::LFMF::GetReturnStatusCharArray (const int code)
	Get an error message string (as C-style string) from a return code.
void	ITS::Propagation::LFMF::FreeReturnStatusCharArray (char *c_msg)
	Free the memory allocated by GetReturnStatusCharArray.
char *	ITS::Propagation::LFMF::GetLibraryNameCharArray ()
	Get library name string (as C-style string).
char *	ITS::Propagation::LFMF::GetLibraryVersionCharArray ()
	Get library version string (as C-style string).

Detailed Description

Maps status messages to library return codes.

Function Documentation

FreeReturnStatusCharArray()

DLLEXPORT void ITS::Propagation::LFMF::FreeReturnStatusCharArray

(

char *

c_msg

)

Free the memory allocated by GetReturnStatusCharArray.

Parameters

[in]

c_msg

The status message C-style string to delete

GetLibraryName()

std::string ITS::Propagation::LFMF::GetLibraryName

(

)

Get library name.

Returns

Library name.

GetLibraryNameCharArray()

DLLEXPORT char * ITS::Propagation::LFMF::GetLibraryNameCharArray

(

)

Get library name string (as C-style string).

Returns

Library name string.

GetLibraryVersion()

std::string ITS::Propagation::LFMF::GetLibraryVersion

(

)

Get library version.

Returns

Library version.

GetLibraryVersionCharArray()

DLLEXPORT char * ITS::Propagation::LFMF::GetLibraryVersionCharArray

(

)

Get library version string (as C-style string).

Returns

Library version string.

GetReturnStatus()

std::string ITS::Propagation::LFMF::GetReturnStatus

(

int

code

)

Get an error message string from a return code.

Parameters

[in]

code

Integer return code.

Returns

A status message corresponding to the input code.

GetReturnStatusCharArray()

DLLEXPORT char * ITS::Propagation::LFMF::GetReturnStatusCharArray

(

const int

code

)

Get an error message string (as C-style string) from a return code.

Parameters

[in]

code

Integer return code.

Returns

A status message corresponding to the input code.