MDAC 2.5 SDK - OLE DB Programmer's Reference
OLE DB Interfaces


 

IErrorRecords::GetBasicErrorInfo

Returns basic information about the error, such as the return code and provider-specific error number.

HRESULT GetBasicErrorInfo (
   ULONG         ulRecordNum,
   ERRORINFO *   pErrorInfo);

Parameters

ulRecordNum

[in]
The zero-based number of the record for which to return information.

pErrorInfo

[out]
A pointer to an ERRORINFO structure in which to return basic error information. This structure is allocated and freed by the consumer. For more information, see "Error Records" in Chapter 16, "Errors."

Return Code

S_OK

The method succeeded.

E_INVALIDARG

pErrorInfo was a null pointer.

DB_E_BADRECORDNUM

ulRecordNum, which is zero-based, was greater than or equal to the count, which is one-based, of records returned by IErrorRecords::GetRecordCount.

Comments

This method should be used only by consumers; there are no reasons for providers to use it.

See Also

IErrorRecords::GetCustomErrorObject, IErrorRecords::GetErrorInfo, IErrorRecords::GetErrorParameters