ADLXHelper_Terminate

Navigation: ADLX SDK References → ADLX Helpers → ADLX Helper Functions

Terminates ADLX and releases ADLX library.

Syntax

ADLX_RESULT ADLXHelper_Terminate ()

Parameters

N/A

Return Value

If ADLXHelper_Terminate is successfully executed, ADLX_OK is returned.

If ADLXHelper_Terminate is not successfully executed, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Remarks

All the interfaces obtained from ADLX must be released with their Release method before ADLXHelper_Terminate is called.

Any interface obtained from ADLX that is not released becomes invalid.

Any attempt of calling ADLX interface after termination could result in errors such as exceptions or crashes.

ADLXHelper_Terminate unloads the ADLX library. Calling Release on an interface after this call dispatches into unloaded code and results in an access violation.

In an application that initializes ADLX at startup and terminates it from an unrelated shutdown path, the interfaces must be released explicitly before ADLXHelper_Terminate is called. This applies to every code path that calls ADLXHelper_Terminate, including the early-exit paths of a partially completed initialization, where some interfaces are already obtained and others are not.

For more information, see Interface lifetime sample.

Requirements

Header	include “ADLXHelper/Windows/C/ADLXHelper.h”
Minimum version	1.0

See Also: InterfaceLifetime, ADLX Enums