获取 OLE 自动化错误信息。

语法

sp_OAGetErrorInfo [objecttoken ]

    [, source OUTPUT]

    [, description OUTPUT]

    [, helpfile OUTPUT]

    [, helpid OUTPUT ]

参数

objecttoken

是先前用 sp_OACreate 创建的 OLE 对象的对象令牌，或 NULL。若指定了 objecttoken，则返回该对象的错误信息。若指定为 NULL，则返回整个批处理的错误信息。

source OUTPUT

是错误信息的来源。如果指定，那么它必须是局部 char、nchar、varchar 或 nvarchar 变量。必要时会截断返回值以适合局部变量的要求。

description OUTPUT

是错误的描述。如果指定，那么它必须是局部 char、nchar、varchar 或 nvarchar 变量。必要时会截断返回值以适合局部变量的要求。

helpfile OUTPUT

是 OLE 对象的帮助文件。如果指定，那么它必须是局部 char、nchar、varchar 或 nvarchar 变量。必要时会截断返回值以适合局部变量的要求。

helpid OUTPUT

是帮助文件的上下文 ID。如果指定，那么它必须是局部 int 变量。

说明  此存储过程的参数按位置指定，而不是按名称。

返回代码值

0（成功）或非零数字（失败），是由 OLE 自动化对象返回的 HRESULT 的整数值。

有关 HRESULT 返回代码的更多信息，请参见 OLE 自动化返回代码和错误信息。

结果集

若未指定输出参数，错误信息将作为结果集返回给客户端。

注释

对每个 OLE 自动化存储过程（sp_OAGetErrorInfo 除外）的调用均会重新设置错误信息；因此，sp_OAGetErrorInfo 只能获取最近一次 OLE 自动化存储过程调用的错误信息。要注意，由于 sp_OAGetErrorInfo 不重新设置错误信息，因此可多次调用该过程以获取相同的错误信息。

下表中列出了 OLE 自动化错误及它们的一般原因。

有关处理 HRESULT 返回代码的更多信息，请参见 OLE 自动化返回代码和错误信息。

权限

只有 sysadmin 固定服务器角色的成员才能执行 sp_OAGetErrorInfo。

示例

下面的示例显示 OLE 自动化错误信息。

DECLARE @output varchar(255)
DECLARE @hr int
DECLARE @source varchar(255)
DECLARE @description varchar(255)
PRINT 'OLE Automation Error Information'
EXEC @hr = sp_OAGetErrorInfo @object, @source OUT, @description OUT
IF @hr = 0
BEGIN
    SELECT @output = '  Source: ' + @source
    PRINT @output
    SELECT @output = '  Description: ' + @description
    PRINT @output
END
ELSE
BEGIN
    PRINT '  sp_OAGetErrorInfo failed.'
    RETURN
END