BCryptGetProperty 関数 (bcrypt.h)

  • [アーティクル]

BCryptGetProperty 関数は、CNG オブジェクトの名前付きプロパティの値を取得します。

構文

NTSTATUS BCryptGetProperty(
  [in]  BCRYPT_HANDLE hObject,
  [in]  LPCWSTR       pszProperty,
  [out] PUCHAR        pbOutput,
  [in]  ULONG         cbOutput,
  [out] ULONG         *pcbResult,
  [in]  ULONG         dwFlags
);

パラメーター

[in] hObject

プロパティ値を取得する CNG オブジェクトを表すハンドル。

[in] pszProperty

取得するプロパティの名前を含む null で終わる Unicode 文字列へのポインター。 これには、定義済みの 暗号化プリミティブ プロパティ識別子またはカスタム プロパティ識別子 のいずれかを指定できます。

[out] pbOutput

プロパティ値を受け取るバッファーのアドレス。 cbOutput パラメーターには、このバッファーのサイズが含まれています。

[in] cbOutput

pbOutput バッファーのサイズ (バイト単位)。

[out] pcbResult

pbOutput バッファーにコピーされたバイト数を受け取る ULONG 変数へのポインター。 pbOutput パラメーターが NULL の場合、この関数は必要なサイズ (バイト単位) をこのパラメーターが指す場所に配置します。

[in] dwFlags

この関数の動作を変更するフラグのセット。 この関数にはフラグは定義されていません。

戻り値

関数の成功または失敗を示す状態コードを返します。

可能なリターン コードには、次のものが含まれますが、これらに限定されません。

リターン コード 説明
STATUS_SUCCESS
 関数は成功しました。
STATUS_BUFFER_TOO_SMALL
 cbOutput パラメーターで指定されたバッファー サイズが、プロパティ値を保持するのに十分な大きさではありません。
STATUS_INVALID_HANDLE
 hObject パラメーターのハンドルが無効です。
STATUS_INVALID_PARAMETER
 1 つ以上のパラメーターが無効です。
STATUS_NOT_SUPPORTED
 pszProperty パラメーターで指定された名前付きプロパティはサポートされていません。

注釈

プロパティに必要なサイズを取得するには、pbOutput パラメーターに NULL を渡します。 この関数は、 pcbResult パラメーターが指す値に必要なサイズをバイト単位で配置します。

プロバイダーがサポートするプロセッサ モードに応じて、 BCryptGetProperty をユーザー モードまたはカーネル モードから呼び出すことができます。 カーネル モードの呼び出し元は、PASSIVE_LEVEL IRQL または IRQL DISPATCH_LEVELで実行できます。 現在の IRQL レベルが DISPATCH_LEVELされている場合、 BCryptGetProperty 関数に渡されるポインターは、非ページ (またはロックされた) メモリを参照する必要があります。 hObject パラメーターで指定されたオブジェクトがハンドルである場合は、BCRYPT_PROV_DISPATCH フラグを使用して開かれている必要があります。

カーネル モードでこの関数を呼び出すには、ドライバー開発キット (DDK) の一部である Cng.lib を使用します。 Windows Server 2008 と Windows Vista: カーネル モードでこの関数を呼び出すには、Ksecdd.lib を使用します。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー bcrypt.h
Library Bcrypt.lib
[DLL] Bcrypt.dll