CancelOverlappedAccess

[This is preliminary documentation and subject to change.]

The CancelOverlappedAccess function cancels an asynchronous operation started by the SetSecurityInfoEx or SetNamedSecurityInfoEx functions.

DWORD CancelOverlappedAccess(
  PACTRL_OVERLAPPED pOverlapped  // pointer to the structure filled 
                                 // in by the asynchronous call
);
 

Parameters

pOverlapped
Pointer to the ACTRL_OVERLAPPED structure that was filled in by the SetSecurityInfoEx or SetNamedSecurityInfoEx call that started the asynchronous operation.

Return Values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value can be one of the following error codes.

Value Meaning
ERROR_CANCEL_IN_PROGRESS A cancel is currently in progress and cannot be restarted.
ERROR_INVALID_PARAMETER The pOverlapped parameter is invalid.
ERROR_OPERATION_ABORTED The asynchronous operation has already been canceled.

Remarks

If the CancelOverlappedAccess function is successful, the pOverlapped structure is no longer valid for GetOverlappedAccessResults or CancelOverlappedAccess calls.

The SetSecurityInfoEx or SetNamedSecurityInfoEx functions can start an asynchronous operation that sets the security on multiple objects, such as on a container object and the objects it contains. If such an operation is canceled, some of the objects might have the new security state while other objects remain in their original security state. In this case, an administrator must examine the objects to determine the appropriate action depending on their states.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in aclapi.h.
  Import Library: Use advapi32.lib.

See Also

Access Control Overview, Access Control Functions, ACTRL_OVERLAPPED, GetOverlappedAccessResults, SetSecurityInfoEx, SetNamedSecurityInfoEx