description | title | ms.date | f1_keywords | helpviewer_keywords | ms.assetid | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Learn more about: IErrorRecordsImpl Class |
IErrorRecordsImpl Class |
11/04/2016 |
|
|
dea8e938-c5d8-45ab-86de-eb8fbf534ffb |
Implements the OLE DB IErrorRecords interface, adding records to and retrieving records from a data member (m_rgErrors) of type CAtlArray<RecordClass
>.
template <class T, class RecordClass = ATLERRORINFO>
class IErrorRecordsImpl : public IErrorRecords
T
A class derived from IErrorRecordsImpl
.
RecordClass
A class that represents an OLE DB error object.
Header: atldb.h
Name | Description |
---|---|
GetErrorDescriptionString | Gets the error description string from an error record. |
GetErrorGUID | Gets the error GUID from an error record. |
GetErrorHelpContext | Gets the help context ID from an error record. |
GetErrorHelpFile | Gets the full pathname of the help file from an error record. |
GetErrorSource | Gets the error source code from an error record. |
Name | Description |
---|---|
AddErrorRecord | Adds a record to the OLE DB error object. |
GetBasicErrorInfo | Returns basic information about the error, such as the return code and provider-specific error number. |
GetCustomErrorObject | Returns a pointer to an interface on a custom error object. |
GetErrorInfo | Returns an IErrorInfo interface pointer on the specified record. |
GetErrorParameters | Returns the error parameters. |
GetRecordCount | Returns the number of records in the OLE DB record object. |
Name | Description |
---|---|
m_rgErrors | An array of error records. |
Gets the error description string from an error record.
LPOLESTR GetErrorDescriptionString(ERRORINFO& rCurError);
rCurError
An ERRORINFO
record in an IErrorInfo
interface.
A pointer to a string describing the error.
Gets the error GUID from an error record.
REFGUID GetErrorGUID(ERRORINFO& rCurError);
rCurError
An ERRORINFO
record in an IErrorInfo
interface.
A reference to a GUID for the error.
Gets the help context ID from an error record.
DWORD GetErrorHelpContext(ERRORINFO& rCurError);
rCurError
An ERRORINFO
record in an IErrorInfo
interface.
The help context ID for the error.
Gets the path name of the help file from an error record.
LPOLESTR GetErrorHelpFile(ERRORINFO& rCurError);
rCurError
An ERRORINFO
record in an IErrorInfo
interface.
Pointer to a string that contains the path name of the help file for the error.
Gets the source code that caused the error from an error record.
LPOLESTR GetErrorSource(ERRORINFO& rCurError);
rCurError
An ERRORINFO
record in an IErrorInfo
interface.
Pointer to a string containing the source code for the error.
Adds a record to the OLE DB error object.
STDMETHOD(AddErrorRecord )(ERRORINFO *pErrorInfo,
DWORD dwLookupID,
DISPPARAMS *pdispparams,
IUnknown *punkCustomError,
DWORD dwDynamicErrorID);
See IErrorRecords::AddErrorRecord in the OLE DB Programmer's Reference.
Returns basic information about the error, such as the return code and provider-specific error number.
STDMETHOD(GetBasicErrorInfo )(ULONG ulRecordNum,
ERRORINFO *pErrorInfo);
See IErrorRecords::GetBasicErrorInfo in the OLE DB Programmer's Reference.
Returns a pointer to an interface on a custom error object.
STDMETHOD(GetCustomErrorObject )(ULONG ulRecordNum,
REFIID riid,
IUnknown **ppObject);
See IErrorRecords::GetCustomErrorObject in the OLE DB Programmer's Reference.
Returns an IErrorInfo interface pointer on the specified record.
STDMETHOD(GetErrorInfo )(ULONG ulRecordNum,
LCID lcid,
IErrorInfo **ppErrorInfo);
See IErrorRecords::GetErrorInfo in the OLE DB Programmer's Reference.
Returns the error parameters.
STDMETHOD(GetErrorParameters )(ULONG ulRecordNum,
DISPPARAMS *pdispparams);
See IErrorRecords::GetErrorParameters in the OLE DB Programmer's Reference.
Returns the number of records in the OLE DB record object.
STDMETHOD(GetRecordCount )(ULONG *pcRecords);
See IErrorRecords::GetRecordCount in the OLE DB Programmer's Reference.
An array of error records.
CAtlArray< RecordClass > m_rgErrors;
OLE DB Provider Templates
OLE DB Provider Template Architecture