IDStorageQueueX::RetrieveErrorRecord

Retrieves an error record.

Syntax

void RetrieveErrorRecord(  
         DSTORAGE_ERROR_RECORD *record  
)  

Parameters

record   _Out_
Type: DSTORAGE_ERROR_RECORD *

Receives the error record.

Return value

Type: void

Remarks

When the error event is signaled, this method can be called to retrieve a DSTORAGE_ERROR_RECORD object. The record contains the count of errors since the previous call to RetrieveErrorRecord and full data for the first failed request.

After the error record is retrieved, do not call this method again before the next error event is signaled. Otherwise, CommandType in DSTORAGE_ERROR_RECORD returns DSTORAGE_COMMAND_TYPE_NONE, indicating no error.

For more information, see the "GetErrorEvent/RetrieveErrorRecord" section in DirectStorage Overview.

Requirements

Header: dstorage_xs.h

Library: dstorage_xs.lib

Supported platforms: Xbox Series consoles

See also

IDStorageQueueX::GetErrorEvent
IDStorageQueueX
DStorage