|
|
|
|
QisBool
Basic Functions |
|
|
|
|
|
|
|
|
|
|
Objective |
|
To
create a new instance of the
QisBool object. |
|
Prototype |
|
void*
QisBool_Create ( char oError[1024] ); |
|
Input Arguments |
|
- |
|
Output Arguments |
|
a.
char oError[1024]: A buffer to store the error message
if this function fails. |
|
Return Value |
|
a.
success: Non-NULL handle to an instance of the QisBool
object. This handle will be used as a parameter to most QisBool functions. b.
failure: NULL. oError will contain a c-string specifying
the reason for failure. |
|
Pre-Conditions |
|
a.
Use this function to create an new instance of
QisBool. b.
Multiple instances of QisBool can co-exist in
parallel. c.
A single instance of QisBool should not be shared
between multiple threads without protecting it's usage with locks/mutexes.
However it is safe to have a separate instance of QisBool for each thread. |
|
Operation |
|
a.
This function allocates and initializes a new instance
of QisBool object. b.
This function checks-out 1 QIS BOOLEAN license every
time it is called. It will fail if it is not able to acquire a license. |
|
Post-Conditions |
|
a.
Every object created using this function must be
eventually destroyed by calling QisBool_Destroy. There is no
automatic garbage collection, therefore the client program is responsible to
manage the destruction of QisBool objects to avoid memory leak/wastage. b.
A QisBool object handle is valid between
QisBool_Create and QisBool_Destroy. |
|
C++ Equivalent |
|
static
IQisBool* IQisBool::Create ( std::string* oError ); |
|
See Also |
|
|
|
|
|
Objective |
|
To
destroy a QisBool object created earlier
using QisBool_Create. |
|
Prototype |
|
void
QisBool_Destroy(void** ioHandle); |
|
Input Arguments |
|
a.
void** ioHandle: Address of the handle identifying a valid
QisBool object. |
|
Output Arguments |
|
a.
void** ioHandle: Address of the handle identifying a valid
QisBool object. The handle is set to NULL. |
|
Return Value |
|
- |
|
Pre-Conditions |
|
a.
Use this function to destroy a QisBool object created
earlier using QisBool_Create. |
|
Operation |
|
a.
This function destroys the data allocated by the
QisBool object. b.
It releases 1 QIS BOOLEAN license. c.
Sets the handle (*ioHandle) to NULL so that it cannot
be used beyond this function call. |
|
Post-Conditions |
|
- |
|
C++ Equivalent |
|
static void
IQisBool::Destroy ( void*& ioHandle ); |
|
See Also |
|
|
|
|
|
Objective |
|
To
return a c-string containing information about an error/warning. |
|
Prototype |
|
const char*
QisBool_ErrorMsg ( int iCode, void* iBoolHandle ); |
|
Input Arguments |
|
a.
int iCode: An error/warning code returned by a QisBool
function. b.
void* iBoolHandle: Handle to a valid QisBool object
for returned by QisBool_Create. |
|
Output Arguments |
|
- |
|
Return Value |
|
a.
const char*: a c-string containing information about
the error/warning corresponding to (iCode). |
|
Pre-Conditions |
|
a.
Use this function to get more information about an
error/warning condition. b.
(iCode) must be an error/warning code returned by a
QisBool function. c.
(iBoolHandle) must represent the same object for which
the QisBool function returned the specified error/warning code. |
|
Operation |
|
a.
Retrieves a c-string corresponding to the
error/warning code (iCode) for the specified QisBool object (iBoolHandle) |
|
Post-Conditions |
|
a.
The error/warning code (iCode) and the corresponding
message are valid for use only immediately after a QisBool function returns. b.
Multiple QisBool functions can return the same
error/warning code for different error/warning conditions. |
|
C++ Equivalent |
|
virtual const
char* IQisBool::ErrorMsg ( int iCode ); |
|
See Also |
|
- |
|
|
|
|
|
|
© 2012 Artwork Conversion
Software Inc. |
|
|
417 Ingalls St. Santa Cruz CA
95060 |
|
|
[T] +1 831-426-6163 [F] +1
831-[E] info@artwork.com |
|