Edit

Information in OLE DB-defined Error Interfaces

  • Article

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

The SQL Server Native Client OLE DB provider reports some error and status information in the OLE DB-defined error interfaces IErrorInfo, IErrorRecords, and ISQLErrorInfo.

The SQL Server Native Client OLE DB provider supports IErrorInfo member functions as follows.

Member function Description
GetDescription Descriptive error message string.
GetGUID GUID of the interface that defined the error.
GetHelpContext Not supported. Always returns zero.
GetHelpFile Not supported. Always returns NULL.
GetSource String "Microsoft SQL Server Native Client".

The SQL Server Native Client OLE DB provider supports consumer-available IErrorRecords member functions as follows.

Member function Description
GetBasicErrorInfo Fills an ERRORINFO structure with basic information about an error. An ERRORINFO structure contains members that identify the HRESULT return value for the error, and the provider and interface to which the error applies.
GetCustomErrorObject Returns a reference on interfaces ISQLErrorInfo, and ISQLServerErrorInfo.
GetErrorInfo Returns a reference on an IErrorInfo interface.
GetErrorParameters The SQL Server Native Client OLE DB provider does not return parameters to the consumer through GetErrorParameters.
GetRecordCount Count of error records available.

The SQL Server Native Client OLE DB provider supports ISQLErrorInfo::GetSQLInfo parameters as follows.

Parameter Description
pbstrSQLState Returns a SQLSTATE value for the error. SQLSTATE values are defined in the SQL-92, ODBC and ISO SQL, and API specifications. Neither SQL Server nor the SQL Server Native Client OLE DB provider defined implementation-specific SQLSTATE values.
plNativeError Returns the SQL Server error number from master.dbo.sysmessages when available. Native errors are available after a successful attempt to initialize a SQL Server Native Client OLE DB provider data source. Prior to the attempt, the SQL Server Native Client OLE DB provider always returns zero.

See Also

Errors