SK_ApiContextDispose Function

Disposes an SK_ApiContext, which clears it from memory and sets it's pointer to NULL (0).

Remarks

Important Note

The SK_FLAGS_APICONTEXTDISPOSE_SHUTDOWN flag must be passed the last time your application calls this function. This should be the last PLUSNative API function your application calls, and it should also be done from your application's main thread (especially when using SK_FLAGS_APICONTEXTINITIALIZE_MAINTHREAD with SK_ApiContextInitialize). This will shutdown the PLUSNative API and will free all memory.

Syntax

C/C++: SK_ResultCode SK_ApiContextDispose(int flags, SK_ApiContext *context);
Visual Basic: Declare Function SK_ApiContextDispose(ByVal flags As Long, ByRef context As Long) As Long

Arguments

flags: Any flags passed into this function-call.

context: Reference/pointer to the API context to dispose.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include:

Result Code	Description
SK_ResultCode.SK_ERROR_NONE	No error.
SK_ResultCode.SK_ERROR_INVALID_ARGUMENTS	Some or all of the arguments are invalid.