Edit

AuthzGetCentralAccessPolicyCallback callback function

  • Article

The AuthzGetCentralAccessPolicyCallback function is an application-defined function that retrieves the central access policy. AuthzGetCentralAccessPolicyCallback is a placeholder for the application-defined function name.

Syntax

BOOL CALLBACK AuthzGetCentralAccessPolicyCallback (
  _In_     AUTHZ_CLIENT_CONTEXT_HANDLE hAuthzClientContext,
  _In_     PSID                        capid,
  _In_opt_ PVOID                       pArgs,
  _Out_    PBOOL                       pCentralAccessPolicyApplicable,
  _Out_    PVOID                       ppCentralAccessPolicy
);

Parameters

hAuthzClientContext [in]

Handle to the client context.

capid [in]

ID of the central access policy to retrieve.

pArgs [in, optional]

Optional arguments that were passed to the AuthzAccessCheck function through the OptionalArguments member of the AUTHZ_ACCESS_REQUEST structure.

pCentralAccessPolicyApplicable [out]

Pointer to a Boolean value that the resource manager uses to indicate whether a central access policy should be used during access evaluation.

ppCentralAccessPolicy [out]

Pointer to the central access policy (CAP) to be used for evaluating access. If this value is NULL, the default CAP is applied.

Return value

If the function succeeds, the function returns TRUE.

If the function is unable to perform the evaluation, it returns FALSE. Use SetLastError to return an error to the access check function.

Requirements

Requirement Value
Minimum supported client
 Windows 8 [desktop apps only]
Minimum supported server
 Windows Server 2012 [desktop apps only]
Redistributable
 Windows Server 2003 Administration Tools Pack on Windows XP

See also

AUTHZ_ACCESS_REQUEST

AUTHZ_INIT_INFO

AuthzAccessCheck