sp_OAGetErrorInfo (Transact-SQL)

構文

sp_OAGetErrorInfo [ objecttoken ]
    [ , source OUTPUT ] 
    [ , description OUTPUT ] 
    [ , helpfile OUTPUT ] 
    [ , helpid OUTPUT ] 

引数

• objecttoken
  以前に sp_OACreate で作成した OLE オブジェクトのオブジェクト トークン、または NULL を指定します。objecttoken を指定した場合、そのオブジェクトのエラー情報が返されます。NULL を指定した場合は、そのバッチ全体のエラー情報が返されます。

• sourceOUTPUT
  エラー情報のソースです。指定する場合、値はローカルの char、nchar、varchar、または nvarchar 型の変数にする必要があります。戻り値は必要に応じてローカル変数のサイズに切り捨てられます。

• descriptionOUTPUT
  エラーの説明です。指定する場合、値はローカルの char、nchar、varchar、または nvarchar 型の変数にする必要があります。戻り値は必要に応じてローカル変数のサイズに切り捨てられます。

• helpfileOUTPUT
  OLE オブジェクトのヘルプ ファイルです。指定する場合、値はローカルの char、nchar、varchar、または nvarchar 型の変数にする必要があります。戻り値は必要に応じてローカル変数のサイズに切り捨てられます。

• helpidOUTPUT
  ヘルプ ファイルのコンテキスト ID です。指定する場合、値はローカルの int 型の変数にする必要があります。

  注
  このストアド プロシージャのパラメータは、名前ではなく位置で指定します。

戻り値

成功した場合は 0、失敗した場合は OLE オートメーション オブジェクトによって返される HRESULT の 0 以外の整数値を返します。

HRESULT の戻り値の詳細については、「OLE オートメーションのリターン コードとエラー情報」を参照してください。

結果セット

出力パラメータを指定しない場合、エラー情報は結果セットとしてクライアントに返されます。

説明

sp_OAGetErrorInfo 以外の各 OLE オートメーション ストアド プロシージャの呼び出しでは、エラー情報がリセットされます。したがって、sp_OAGetErrorInfo では直前の OLE オートメーション ストアド プロシージャ呼び出しのエラー情報だけが取得されます。sp_OAGetErrorInfo ではエラー情報がリセットされないので、同じエラー情報を取得するため何度も呼び出すことができます。

次の表は、OLE オートメーション エラーと一般的な原因の一覧です。

HRESULT の戻り値の処理に関する詳細については、「OLE オートメーションのリターン コードとエラー情報」を参照してください。

権限

sysadmin 固定サーバー ロールのメンバシップが必要です。

例

次の例では、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

関連項目

参照