PvkGetCryptProv 関数

  • [アーティクル]

重要

この API は非推奨です。 Microsoft は、今後のリリースでこの API を削除する可能性があります。

 

PvkGetCryptProv 関数は、秘密キー ファイルまたはキー コンテナー名に基づいて、暗号化サービス プロバイダー (CSP) へのハンドルを取得します。

Note

この関数には、ヘッダー ファイルまたはインポート ライブラリが関連付けされません。 この関数を呼び出すには、ユーザー定義ヘッダー ファイルを作成し、 LoadLibrary 関数と GetProcAddress 関数を使用して、Mssign32.dllに動的にリンクする必要があります。

 

構文

HRESULT WINAPI PvkGetCryptProv(
  _In_      HWND       hwnd,
  _In_      LPCWSTR    pwszCaption,
  _In_      LPCWSTR    pwszCapiProvider,
  _In_      DWORD      dwProviderType,
  _In_      LPCWSTR    pwszPvkFile,
  _In_      LPCWSTR    pwszKeyContainerName,
  _Out_     DWORD      *pdwKeySpec,
  _Out_opt_ LPWSTR     *ppwszTmpContainer,
  _Out_     HCRYPTPROV *phCryptProv
);

パラメーター

hwnd [in]

秘密キー ファイルの暗号化を解除するためにパスワードが必要な場合、このパラメーターはパスワード ダイアログ ボックスの親へのハンドルです。それ以外の場合は NULL です。

pwszCaption [in]

ダイアログ ボックスの null で終わる文字列へのポインターキャプション。

pwszCapiProvider [in]

CSP 名の null で終わる文字列へのポインター。

dwProviderType [in]

暗号化プロバイダーの種類を表す DWORD 値。 詳細については、「 暗号化プロバイダーの種類」を参照してください。

pwszPvkFile [in]

秘密キー ファイルの名前を含む null で終わる文字列へのポインター。

pwszKeyContainerName [in]

秘密キー コンテナー名の null で終わる文字列へのポインター。

pdwKeySpec [out]

phCryptProv と ppwszTmpContainer で返されるコンテナーのキーの種類の DWORD 値へのポインター。

ppwszTmpContainer [out, optional]

一時キー コンテナー名の null で終わる文字列へのポインターのアドレス。 PvkGetCryptProv 関数は、一時コンテナーを提供して初期化します。 PvkGetCryptProv を呼び出すときは、アドレスが NULL 値を指している必要があります。

phCryptProv [out]

CSP のハンドルへのポインター。

戻り値

メソッドが成功すると、 S_OKが返されます。

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

解説

PvkGetCryptProv 関数は、まず pwszKeyContainerName パラメーターで指定されたキー コンテナー名からプロバイダー ハンドルを取得しようとします。 pwszKeyContainerName パラメーターに NULL を渡すと、PvkGetCryptProv は pwszPvkFile パラメーターで指定された秘密キー ファイルからプロバイダーを取得しようとします。

CSP の使用が完了したら、 PvkFreeCryptProv 関数を呼び出してプロバイダー ハンドルと一時キー コンテナーを解放します。

必要条件

要件 値
サポートされている最小のクライアント
 Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server 2003 [デスクトップ アプリのみ]
[DLL]
Mssign32.dll