Bool.dll Library Logo

 

Initialization and Clean Up Functions



 

BoolDllReserveLicenses

Syntax:

BoolDllReserveLicenses(const char *startdir, int number_of_licenses_to_reserve);

Function:

Gets one or more licenses from the license manager (more than one license is needed if multiple threads are to be executed)

Inputs:

startdir - the full path to where the calling application resides. The acs.key file must be located in this directory.

number_of_licenses_to_reserve - the number of execution licenses - one is needed for each independent thread of bool library.

Return Codes:

-1  error reserving license
 0  license reserved successfully

Note:

Must be called before any other function is called. All number_of_licenses_to_reserve are checked out with this call. This represents the number of concurrent calls that can be made to BoolDllInit_MT without an intervening call to BoolDllClose_MT.




BoolDllInit_MT

Syntax:

int BoolDllInit_MT();

Function:

Initializes the bool.dll library and returns a handle.

Inputs:

Returns

the handle to be used;a non-negative integer (limited to the number of licenses reserved using BoolDllReserveLicenses.)
Error Codes
    -1 cannot get a handle; probably the result of an unhandled exception.
    -2 cannot get a handle because a call to BoolDllReserveLicenses was not made or the number of handles already in use is equal to the number of reserved licenses.
    -3 memory allocation failure.

Note:

Must be called before any other function, except for a reserve license call, is made.




BoolDllClose_MT

Syntax:

int BoolDllClose_MT( int bdll_handle );

Function:

does cleanup associated with the handle and returns the handle to the handle pool.

Input:

bdll_handle - handle to close

Returns

 0 normal close
-1 invalid handle



BoolDllReleaseLicenses

Syntax:

void BoolDllReleaseLicenses( );

Function:

releases the pool of licenses. This should be the last call after closing.




BoolRelease_array

Syntax:

void BoolRelease_array(int* Polygon);

Function:

frees memory associated with the polygon that was created by a prior call to library function.

Inputs:

Polygon - the array of XY pairs.

Note:

Use this function following: RtnEdges_MT




BoolRelease_memory

Syntax:

void BoolRelease_memory( int**Polygons, int* Vertices, int N );

Function:

frees memory associated with the array of polygons and vertices that were created by a prior call to library function.

Inputs:

Polygons - array of polygon arrays returned by a prior call to the library.

Vertices - array of polygon vertex counts returned by a prior call to the library

N - number of polygon arrays.

Note:

Use this function following calls to: PolyBreak, Convexing,Path2BndrysU,Opath2Bndrys,Path2Bndrys,PathClip2Wind





  Documentation Download Price Revision History