Win32 API 日本語リファレンス
ホーム › System.Wmi › IWbemStatusCodeText

IWbemStatusCodeText

COM
📘 Microsoft Learn (日本語) · English
IIDeb87e1bc-3233-11d2-aec9-00c04fb68820継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWbemStatusCodeText インターフェイスは、エラーコードの説明テキスト文字列、またはエラーが発生したサブシステムの名前を取得します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetErrorCodeText(HRESULT hRes, DWORD LocaleId, INT lFlags, LPWSTR* MessageText)

エラーコードに関連付けられた説明テキスト文字列を返します。

hResHRESULTin説明を取得したいエラーコードのハンドル。
LocaleIdDWORDin予約済み。このパラメーターは 0 (ゼロ) にする必要があります。
lFlagsINTin予約済み。このパラメーターは 0 (ゼロ) にする必要があります。
MessageTextLPWSTR*outエラーコードの説明テキストを格納する文字列へのポインター。

戻り値

このメソッドは、成功した場合に WBEM_S_NO_ERROR を返します。

解説(Remarks)

GetErrorCodeText が説明テキスト文字列を 返せるようにするため、呼び出し側は MessageText パラメーターのポインターを解放する必要があります。

例

次の例は、GetErrorCodeText の実装方法を示しています。

IWbemStatusCodeText * pStatus = NULL;

    SCODE sc = CoCreateInstance(CLSID_WbemStatusCodeText,
                                0, 
                                CLSCTX_INPROC_SERVER,
                                IID_IWbemStatusCodeText,
                                (LPVOID *) &pStatus);
    
    if(sc == S_OK)
    {
        BSTR bstr = 0;

        // m_hres は、すでに宣言および初期化された
        // HRESULT 変数です。
        sc = pStatus->GetErrorCodeText(m_hres, 0, 0, &bstr);
        if(sc == S_OK)
        {
            // TODO: これを表示する
            SysFreeString(bstr);
            bstr = 0;
        }
        sc = pStatus->GetFacilityCodeText(m_hres, 0, 0, &bstr);
        if(sc == S_OK)
        {
            // TODO: これを表示する
            SysFreeString(bstr);
            bstr = 0;
        }
        pStatus->Release();
    }

    // クリーンアップ。
    pStatus->Release();
vtbl 4 HRESULT GetFacilityCodeText(HRESULT hRes, DWORD LocaleId, INT lFlags, LPWSTR* MessageText)

IWbemStatusCodeText::GetFacilityCodeText メソッドは、エラーが発生したサブシステムの名前 ("Windows"、"WBEM"、"SSPI"、"RPC" など) を返します。

hResHRESULTin説明を取得したいエラーコードのハンドル。
LocaleIdDWORDin予約済み。このパラメーターは 0 (ゼロ) にする必要があります。
lFlagsINTin予約済み。このパラメーターは 0 (ゼロ) にする必要があります。
MessageTextLPWSTR*outエラーコードの説明テキストを格納する文字列へのポインター。

戻り値

このメソッドは、成功した場合に WMI_S_NO_ERROR を返します。

解説(Remarks)

GetFacilityCodeText メソッドがサブシステム名を 返せるようにするため、呼び出し側は MessageText パラメーターのポインターを解放する必要があります。

例

次の例は、GetFacilityCodeText の使用方法を示しています。

IWbemStatusCodeText * pStatus = NULL;

    SCODE sc = CoCreateInstance(CLSID_WbemStatusCodeText, 
                                    0, CLSCTX_INPROC_SERVER,
                                    IID_IWbemStatusCodeText,
                                    (LPVOID *) &pStatus);
    
    if(sc == S_OK)
    {
        BSTR bstr = 0;

        // m_hres は、すでに宣言および初期化された
        // HRESULT 変数です。
        sc = pStatus->GetErrorCodeText(m_hres, 0, 0, &bstr);
        if(sc == S_OK)
        {
            // ...ここで文字列を表示する。
            SysFreeString(bstr);
            bstr = 0;
        }
        sc = pStatus->GetFacilityCodeText(m_hres, 0, 0, &bstr);
        if(sc == S_OK)
        {
            // TODO: これを表示する。
            SysFreeString(bstr);
            bstr = 0;
        }
        pStatus->Release();
    }

    // クリーンアップ。
    pStatus->Release();
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IWbemStatusCodeText "{EB87E1BC-3233-11D2-AEC9-00C04FB68820}"
#usecom global IWbemStatusCodeText IID_IWbemStatusCodeText "{EB87E1BD-3233-11D2-AEC9-00C04FB68820}"
#comfunc global IWbemStatusCodeText_GetErrorCodeText     3 int,int,int,var
#comfunc global IWbemStatusCodeText_GetFacilityCodeText  4 int,int,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。