DeactivateActCtx function (winbase.h)

Article
10/13/2021

The DeactivateActCtx function deactivates the activation context corresponding to the specified cookie.

Syntax

BOOL DeactivateActCtx(
  [in] DWORD     dwFlags,
  [in] ULONG_PTR ulCookie
);

Parameters

[in] dwFlags

Flags that indicate how the deactivation is to occur.

Value	Meaning
0	If this value is set and the cookie specified in the ulCookie parameter is in the top frame of the activation stack, the activation context is popped from the stack and thereby deactivated. If this value is set and the cookie specified in the ulCookie parameter is not in the top frame of the activation stack, this function searches down the stack for the cookie. If the cookie is found, a STATUS_SXS_EARLY_DEACTIVATION exception is thrown. If the cookie is not found, a STATUS_SXS_INVALID_DEACTIVATION exception is thrown. This value should be specified in most cases.
DEACTIVATE_ACTCTX_FLAG_FORCE_EARLY_DEACTIVATION	If this value is set and the cookie specified in the ulCookie parameter is in the top frame of the activation stack, the function returns an ERROR_INVALID_PARAMETER error code. Call GetLastError to obtain this code. If this value is set and the cookie is not on the activation stack, a STATUS_SXS_INVALID_DEACTIVATION exception will be thrown. If this value is set and the cookie is in a lower frame of the activation stack, all of the frames down to and including the frame the cookie is in is popped from the stack.

Value

Meaning

0

If this value is set and the cookie specified in the ulCookie parameter is in the top frame of the activation stack, the activation context is popped from the stack and thereby deactivated.

If this value is set and the cookie specified in the ulCookie parameter is not in the top frame of the activation stack, this function searches down the stack for the cookie.

If the cookie is found, a STATUS_SXS_EARLY_DEACTIVATION exception is thrown.

If the cookie is not found, a STATUS_SXS_INVALID_DEACTIVATION exception is thrown.

This value should be specified in most cases.

DEACTIVATE_ACTCTX_FLAG_FORCE_EARLY_DEACTIVATION

If this value is set and the cookie specified in the ulCookie parameter is in the top frame of the activation stack, the function returns an ERROR_INVALID_PARAMETER error code. Call GetLastError to obtain this code.

If this value is set and the cookie is not on the activation stack, a STATUS_SXS_INVALID_DEACTIVATION exception will be thrown.

If this value is set and the cookie is in a lower frame of the activation stack, all of the frames down to and including the frame the cookie is in is popped from the stack.

[in] ulCookie

The ULONG_PTR that was passed into the call to ActivateActCtx. This value is used as a cookie to identify a specific activated activation context.

Return value

If the function succeeds, it returns TRUE. Otherwise, it returns FALSE.

This function sets errors that can be retrieved by calling GetLastError. For an example, see Retrieving the Last-Error Code. For a complete list of error codes, see System Error Codes.

Remarks

The deactivation of activation contexts must occur in the reverse order of activation. It can be understood as popping an activation context from a stack.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	winbase.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll