ICEnroll3::GetAlgName メソッド (xenroll.h)

[アーティクル]
03/04/2024

[このメソッドは、Windows Server 2008 および Windows Vista では使用できなくなりました。

GetAlgName メソッドは、ID を指定して暗号化アルゴリズムの名前を取得します。このメソッドによって取得される値は、現在の暗号化サービスプロバイダー (CSP) によって異なります。このメソッドは、 ICEnroll3 インターフェイスで最初に定義されました。

構文

HRESULT GetAlgName(
  [in]  LONG algID,
  [out] BSTR *pbstr
);

パラメーター

[in] algID

Wincrypt.h で定義されている暗号化アルゴリズムを表す値。たとえば、CALG_MD2は定義されたアルゴリズム識別子です。この方法を成功させるには、現在の CSP で algID アルゴリズムがサポートされている必要があります。

[out] pbstr

成功すると、algID で指定されたアルゴリズムの名前を表す BSTR へのポインター。 BSTR の使用が完了したら、SysFreeString 関数を呼び出して解放します。

戻り値

C++

戻り値は HRESULT です。値 S_OK は成功を示します。 CSP がこのメソッドをサポートしていない場合、または algID 暗号化アルゴリズムをサポートしていない場合は、エラーが返されます。

VB

戻り値は、 algID で指定されたアルゴリズムの名前を表す文字列です。 CSP がこのメソッドをサポートしていない場合は、エラーが返されます。

注釈

このメソッドは、 EnumAlgs を呼び出すことによって ID が取得されるアルゴリズムの名前を表示するために使用できます。

暗号化アルゴリズムの定数は Wincrypt.h で定義されます。

例

BSTR      bstrAlgName = NULL;

HRESULT   hr;

// Retrieve the algorithm name.
// dwAlgID is a DWORD variable for an algorithm ID.
hr = pEnroll->GetAlgName( dwAlgID, &bstrAlgName);
if (FAILED(hr))
    printf("Failed GetAlgName [%x]\n", hr);
else
    printf("AlgID: %d Name: %S\n", dwAlgID, bstrAlgName );

// Free BSTR resource.
if ( NULL != bstrAlgName )
{
    SysFreeString( bstrAlgName );
    bstrAlgName = NULL;
}

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	xenroll.h
Library	Uuid.lib
[DLL]	Xenroll.dll