Starts, configures, and terminates a session with the library. More...
Functions | |
A3DStatus | A3DDisableHandleSIGSEGV () |
Disables internal SIGSEGV handling (Linux only) More... | |
A3DStatus | A3DDllGetBuildInformation (A3DUTF8Char **ppBuildInformation) |
Gets information relative to build. More... | |
A3DStatus | A3DDllGetVersion (A3DInt32 *piMajorVersion, A3DInt32 *piMinorVersion) |
Gets the version identifiers for the currently installed library. More... | |
A3DStatus | A3DDllInitialize (A3DInt32 iMajorVersion, A3DInt32 iMinorVersion) |
Starts a session with the library. More... | |
A3DStatus | A3DDllIsInitialized () |
Gets the status of the library initialization library. More... | |
A3DStatus | A3DDllTerminate () |
Terminates a session with the library. More... | |
A3DStatus | A3DEnableHandleSIGSEGV () |
Enables internal SIGSEGV handling (Linux only) More... | |
Detailed Description
Starts, configures, and terminates a session with the library.
The functions in this section start and terminate a session with the library.
Function Documentation
◆ A3DDllInitialize()
Starts a session with the library.
This function initializes the internal structures in the library.
- Version
- 2.0
- Parameters
-
iMajorVersion The major version of the HOOPS Exchange. Set this value to A3D_DLL_MAJORVERSION
iMinorVersion The minor version of the HOOPS Exchange. Set this value to A3D_DLL_MINORVERSION
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
<tt>A3D_INITIALIZE_ALREADY_CALLED</tt> <tt>A3D_SUCCESS</tt>
- Warning
- You must call this function before calling any other functions in the HOOPS Exchange, with these exceptions:
-
You can call
A3DDllGetVersion
anytime. -
To have the library produce an XML trace file, you must call
A3DDllActivateXMLTrace
before calling this function.
-
You can call
- Sample code
◆ A3DDisableHandleSIGSEGV()
A3DStatus A3DDisableHandleSIGSEGV | ( | ) |
Disables internal SIGSEGV handling (Linux only)
This function deactivates the handling of the SIGSEGV signal on Linux. By default, SIGSEGV is handled and an exception is thrown to return A3D_EXCEPTION.
- Warning
- You must call this function before
A3DDllInitialize
- Deprecated:
- the default behavior has changed with 11.2 to disable the SIGSEGV handling
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
◆ A3DEnableHandleSIGSEGV()
A3DStatus A3DEnableHandleSIGSEGV | ( | ) |
Enables internal SIGSEGV handling (Linux only)
This function activates the handling of the SIGSEGV signal on Linux. When this function is activated, SIGSEGV is handled and an exception is thrown to return A3D_EXCEPTION.
- Warning
- You must call this function before
A3DDllInitialize
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
◆ A3DDllTerminate()
A3DStatus A3DDllTerminate | ( | ) |
Terminates a session with the library.
This function terminates a session with the library. It deallocates memory it has previously allocated for its internal use.
You must call this function to end a session with the library.
- Version
- 2.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
◆ A3DDllGetVersion()
Gets the version identifiers for the currently installed library.
This function returns the version of the currently installed library. 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 library.
To ensure compatibility, the A3D_DLL_MAJORVERSION
must be identical to the major version of currently installed library, and the A3D_DLL_MINORVERSION
must be less than or equal to the minor version of the currently installed library.
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 in case of success or an error code
- Return values
-
◆ A3DDllGetBuildInformation()
A3DStatus A3DDllGetBuildInformation | ( | A3DUTF8Char ** | ppBuildInformation | ) |
Gets information relative to build.
This function returns build information. This can be asked by support to help solving problem. This function does not allocate memory.
- Version
- 14.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
◆ A3DDllIsInitialized()
A3DStatus A3DDllIsInitialized | ( | ) |
Gets the status of the library initialization library.
This function returns the status of the library initialization library.
This function does not allocate memory.
- Version
- 11.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-