< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Functions
A3DLIBS Start/Terminate Functions

Starts, configures, and terminates a session with the A3DLIBS. More...

Functions

A3DStatus A3DDllInitialize (A3DInt32 iMajorVersion, A3DInt32 iMinorVersion)
 Starts a session with the A3DLIBS. More...
 
A3DStatus A3DDllTerminate ()
 Terminates a session with the A3DLIBS. More...
 
A3DStatus A3DDllGetVersion (A3DInt32 *piMajorVersion, A3DInt32 *piMinorVersion)
 Gets the version identifiers for the currently installed A3DLIBS. More...
 

Detailed Description

Starts, configures, and terminates a session with the A3DLIBS.

The functions in this section start and terminate a session with the A3DLIBS.

Function Documentation

A3DStatus A3DDllInitialize ( A3DInt32  iMajorVersion,
A3DInt32  iMinorVersion 
)

Starts a session with the A3DLIBS.

This function initializes the internal structures in the A3DLIBS.

Version
2.0
Parameters
iMajorVersionThe major version of the HOOPS Publish API. Set this value to A3D_DLL_MAJORVERSION
iMinorVersionThe minor version of the HOOPS Publish API. Set this value to A3D_DLL_MINORVERSION
Returns
A3D_INITIALIZE_ALREADY_CALLED
A3D_SUCCESS
Warning
You must call this function before calling any other functions in the HOOPS Publish API, with these exceptions:
Sample code
A3DInt32 iMajorVersion = 0, iMinorVersion = 0;
iErr = A3DDllGetVersion( &iMajorVersion, &iMinorVersion );
if( iMajorVersion != A3D_DLL_MAJORVERSION )
iErr = A3D_ERROR;
else if( iMinorVersion < A3D_DLL_MINORVERSION )
iErr = A3D_ERROR;
if( iErr == A3D_SUCCESS )
{
if ( iErr == A3D_SUCCESS )
{
/* Insert your own code to create/read models */
/* ... */
/* At end of process, terminate the DLL use */
iErr = A3DDllTerminate();
}
}
A3DStatus A3DDllTerminate ( )

Terminates a session with the A3DLIBS.

This function terminates a session with the A3DLIBS. It deallocates memory it has previously allocated for its internal use.

You must call this function to end a session with the A3DLIBS.

Version
2.0
Returns
A3D_INITIALIZE_NOT_CALLED
A3D_SUCCESS
Warning
You can call this function only after successfully calling A3DDllInitialize.
When your process is done with A3DLIBS.dll (after calling A3DDllTerminate), you MUST unload that DLL, as shown in the sample code for A3DDllInitialize. Unloading the DLL helps to avoid conflicts that can occur when multiple processes use A3DLIBS.dll.
Processes must avoid parallel access to A3DLIBS.dll.
A3DStatus A3DDllGetVersion ( A3DInt32 piMajorVersion,
A3DInt32 piMinorVersion 
)

Gets the version identifiers for the currently installed A3DLIBS.

This function returns the version of the currently installed A3DLIBS. Use these version identifiers to determine whether that library is compatible with your application. The value returned through the piMajorVersion argument is identical to the Acrobat version identifier. The value returned through the piMinorVersion argument is specific to the A3DLIBS.

To ensure compatibility, the A3D_DLL_MAJORVERSION must be identical to the major version of currently installed A3DLIBS, and the A3D_DLL_MINORVERSION must be less than or equal to the minor version of the currently installed A3DLIBS.

You can call A3DDllGetVersion anytime, even before calling A3DDllInitialize and after calling A3DDllTerminate. This function does not allocate memory.

Version
2.0
Returns
A3D_SUCCESS