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

[アーティクル]
08/28/2023

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

GetKeyLen メソッドは、署名キーと交換キーのキーの最小長と最大長を取得します。このメソッドは、 ICEnroll3 インターフェイスで最初に定義されました。このメソッドによって取得される値は、現在の暗号化サービスプロバイダーによって異なります。

構文

HRESULT GetKeyLen(
  [in]  BOOL fMin,
  [in]  BOOL fExchange,
  [out] LONG *pdwKeySize
);

パラメーター

[in] fMin

取得するキーの長さ (最小または最大) を示すブール値。 fMin が TRUE の場合、キーの最小長が取得されます。FALSE の場合は、キーの最大長が取得されます。

[in] fExchange

キーの種類を示すブール値。 fExchange が TRUE の場合、交換キーの長さが取得されます。FALSE の場合は、署名キーの長さが取得されます。

[out] pdwKeySize

キーの最小または最大長をビット単位で受け取るポインター。

戻り値

C++

メソッドが成功した場合、メソッドは S_OKを返し、*pdwKeySize はキーの最小または最大長の長さ (ビット単位) を表す値になります。

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、「共通の HRESULT 値」を参照してください。

VB

キーの最小または最大長の長さをビット単位で表す値。

注釈

このメソッドを呼び出して、キーの最小長と最大長を確認します。 CSP がこのメソッドをサポートしていない場合は、エラーが返されます。

例

DWORD dwExchMin, dwExchMax, dwSignMin, dwSignMax;

// Determine the minimum and maximum key length values.
// hr is HRESULT variable.
hr = pEnroll->GetKeyLen( TRUE, TRUE, &dwExchMin );
if ( FAILED( hr ) )    
    printf("Failed GetKeyLen for Exchange Minimum [%x]\n", hr);
else
    printf("Exchange key Min: %d\n", dwExchMin);

hr = pEnroll->GetKeyLen( FALSE, TRUE, &dwExchMax );
if ( FAILED( hr ) )
    printf("Failed GetKeyLen for Exchange Maximum [%x]\n", hr);
else
    printf("Exchange key Max: %d\n", dwExchMax );

hr = pEnroll->GetKeyLen( TRUE, FALSE, &dwSignMin );
if ( FAILED( hr ) )
    printf("Failed GetKeyLen for Signature Minimum [%x]\n", hr);
else
    printf("Signature key Min: %d\n", dwSignMin );

hr = pEnroll->GetKeyLen( FALSE, FALSE, &dwSignMax );
if ( FAILED( hr ) )    
    printf("Failed GetKeyLen for Signature Maximum [%x]\n", hr);
else
    printf("Signature key Max: %d\n", dwSignMax );

要件

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