Chapter 6    C-Level Application Programming Interface (API)

JADE provides C-level API calls that help C programmers to write external methods and functions to obtain JADE initialization file information, directory information, and to convert JADE characters to an ANSI or Unicode string. This enables consistent behavior between the C-level code and the JADE runtime.

Function prototypes for these call, which are listed in the following table, are defined in the joscalls.h header in the include directory on the JADE release medium. The C functions return an int value, which will be zero (0) to indicate success or a JADE Object Manager error number.

API Call	For details, see…	Description
jomDecimalCompare	Comparing Decimal Values	Compares two Decimal values
jomDecimalFromInt64Scale	Converting an Integer64 to a Decimal	Converts an Integer64 value with scale factor to a Decimal value
jomDecimalFromReal	Converting a Real to a Decimal	Converts a Real value to a Decimal value
jomDecimalFromString	Converting a String to a Decimal	Converts a String containing a fixed‑point value to a Decimal value
jomDecimalToReal	Converting a Decimal to a Real	Converts a Decimal value to a Real value
jomDecimalToString	Converting a Decimal to a String	Converts a Decimal value to its String representation
josDskDateToGregorian	Converting a Date Value to a Gregorian Value	Converts a Julian Date value to Gregorian Integer values
josDskTimeStampCompare	Comparing TimeStamp Values	Compares two TimeStamp values
josDskTimeStampToGregorianHMSm	Converting a TimeStamp Value to a Gregorian Value	Converts a TimeStamp value to Gregorian date and HMS (hours, minutes, seconds) Integer values
josIniFileGetFileName	Getting the Name of the Initialization File	Obtains the name of the JADE initialization file
josIniFileGetBoolean	Getting a Boolean Value form the Initialization File	Obtains a Boolean value from the JADE initialization file
josIniFileGetSInteger	Getting a Signed Integer Value from the Initialization File	Obtains a signed Integer value from the JADE initialization file
josIniFileGetUInteger	Getting an Unsigned Integer Value from the Initialization File	Obtains an unsigned Integer value from the JADE initialization file
josIniFileGetString	Getting a String Value from the Initialization File	Obtains a String value from the JADE initialization file
josIniFileSetBoolean	Setting a Boolean Value form the Initialization File	Sets the Boolean value of a JADE initialization file key
josIniFileSetSInteger	Setting a Signed Integer Value from the Initialization File	Sets the signed Integer value of a JADE initialization file key
josIniFileSetUInteger	Setting an Unsigned Integer Value from the Initialization File	Sets the unsigned Integer value of a JADE initialization file key
josIniFileSetString	Setting a String Value from the Initialization File	Sets the String value of a JADE initialization file key
josGetDirectoryJade	Getting the JADE HOME Directory	Obtains the name of the JADE HOME directory
josGetDirectoryJadeBin	Getting the JADE Installation Directory	Obtains the name of the JADE installation directory
josGetDirectoryJadeLib	Getting the JADE Lib Directory	Obtains the name of the directory in which JADE shared objects and libraries are installed
josGetDirectoryJadeTemp	Getting the JADE Temp Directory	Obtains the name of the JADE temp directory
josCharacterToAnsi	Converting a JADE Character to an ANSI Value	Converts a JADE Character type to an ANSI value
josCharacterToUnicode	Converting a JADE Character to a Unicode Value	Converts a JADE Character type to a Unicode value

For details, see the following subsections.