IDStorageQueueX::CancelRequestsWithTag

Attempts to cancel a group of previously enqueued read requests.

Syntax

void CancelRequestsWithTag(  
         UINT64 mask,  
         UINT64 value  
)  

Parameters

mask
Type: UINT64

The mask for the cancellation formula.

value
Type: UINT64

The value for the cancellation formula.

Return value

Type: void

Remarks

All previously enqueued requests whose CancellationTag matches the formula (CancellationTag & mask) == value will be cancelled.

A cancellation request might or might not be able to cancel a read request. A cancelled request is not counted as a failure in either IDStorageStatusArrayX or DSTORAGE_ERROR_RECORD.

This method cancels requests that were enqueued before the method was called. Requests enqueued after the method returns are not affected.

Note

Whether requests enqueued by another thread during the method call are cancelled is undefined.

Requirements

Header: dstorage_xs.h

Library: dstorage_xs.lib

Supported platforms: Xbox Series consoles

See also

IDStorageQueueX
DStorage