IErrorRecords::GetCustomErrorObject

OLE DB Programmer's Reference

Returns a pointer to an interface on the custom error object.

HRESULT GetCustomErrorObject (    ULONG         ulRecordNum,    REFIID        riid,    IUnknown    **ppObject);

Parameters

ulRecordNum: [in]
The zero-based number of the record for which to return a custom error object.
riid: [in]
The IID of the interface to return.
ppObject: [out]
A pointer to memory in which to return an interface pointer on the custom error object. If there is no custom error object, a null pointer is returned; that is, *ppObject is a null pointer.

Return Code

S_OK: The method succeeded.
E_INVALIDARG: ppObject was a null pointer.
E_NOINTERFACE: The custom error object did not support the interface specified in riid.
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.