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


 

IErrorRecords::GetErrorInfo

Returns an IErrorInfo interface pointer on the specified record.

HRESULT GetErrorInfo (
   ULONG           ulRecordNum,
   LCID            lcid,
   IErrorInfo **   ppErrorInfo);

Parameters

ulRecordNum

[in]
The zero-based number of the record for which to return an IErrorInfo interface pointer.

lcid

[in]
The locale ID for which to return error information. This parameter is checked when it is passed to methods in IErrorInfo.

ppErrorInfo

[out]
A pointer to memory in which to return a pointer to an IErrorInfo interface on the specified record. This IErrorInfo interface pointer is different from the IErrorInfo interface pointer exposed on the OLE DB error object with QueryInterface. For more information, see "OLE DB Error Objects" in Chapter 16, "Errors."

Return Code

S_OK

The method succeeded.

E_INVALIDARG

ppErrorInfo 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::GetBasicErrorInfo, IErrorRecords::GetCustomErrorObject, IErrorRecords::GetErrorParameters