ADLXHelper_InitializeWithCallerAdl
Navigation: ADLX SDK References → ADLX Helpers → ADLX Helper Functions
Syntax
ADLX_RESULT ADLXHelper_InitializeWithCallerAdl (adlx_handle adlContext, ADLX_ADL_Main_Memory_Free adlMainMemoryFree)
Parameters
| # | Direction | Name | Type | Description |
|---|---|---|---|---|
| 1. | [in] | adlContext | adlx_handle | The ADL context. |
| # | Direction | Name | Type | Description |
| --- | --- | --- | --- | --- |
| 2. | [in] | adlMainMemoryFree | ADLX_ADL_Main_Memory_Free | The callback handler of the memory deallocation function. |
Return Value
If ADLXHelper_InitializeWithCallerAdl is successfully executed, ADLX_OK is returned.
If ADLXHelper_InitializeWithCallerAdl is not successfully executed, an error code is returned.
If ADLX was previously successfully initialized with any of the Initialize versions, ADLX_ALREADY_INITIALIZED is returned.
Refer to ADLX_RESULT for success codes and error codes.
Remarks
This function is used when an application also uses ADL. A typical scenario is the application is transitioning from ADL to ADLX with some programming already completed with ADL.
In such case, the application shall pass the parameters in this function that corresponds to the current ADL initialization already in use, which are: an ADL context and a callback for the memory deallocation when ADL was initialized.
For more information for initializing ADLX with an ADL context, refer to Using ADLX in an ADL application.
Requirements
| Header | include “ADLXHelper/Windows/C/ADLXHelper.h” |
|---|---|
| Minimum version | 1.0 |
Related Pages
See Also: Using ADLX in an application