翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# キーストレージプロバイダー (KSP) を使用した NCryptGetProperty
<a name="ksp-library-apis-get-property"></a>

`NCryptGetProperty` 関数は、キーストレージオブジェクトのプロパティ値を取得します。

## パラメータ
<a name="ksp-library-apis-create-get-property-parameters"></a>

 `hObject` [in]   
 プロパティを取得する対象のオブジェクトのハンドル。次を使用できます。  
+ プロバイダーハンドル (`NCRYPT_PROV_HANDLE`)
+ キーハンドル (`NCRYPT_KEY_HANDLE`)

 `pszProperty ` [in]   
取得するプロパティ名を含む null 終端 Unicode 文字列へのポインタ。  
を使用する場合`NCRYPT_PROV_HANDLE`、 AWS CloudHSM キーストレージプロバイダー (KSP) は次の KSP 識別子をサポートします。    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
を使用する場合`NCRYPT_KEY_HANDLE`、 AWS CloudHSM キーストレージプロバイダー (KSP) は次の KSP 識別子をサポートします。    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
値は、リテラルの前に L が付いていることからわかるように、ワイド文字列リテラルです。

 `pbOutput` [out]   
プロパティ値を保存するバッファのアドレス。`cbOutput` を使用してバッファサイズを指定します。  
必要なバッファサイズを決定するには、このパラメータを NULL に設定します。この関数は、必要なサイズ (バイト単位) を `pcbResult` が指す場所に保存します。

 `cbOutput` [in]   
 `pbOutput` バッファのサイズ (バイト単位)。

`pcbResult` [out]  
`pbOutput` バッファにコピーされたバイト数を保存する DWORD 変数へのポインタ。  
`pbOutput` が NULL の場合、必要なサイズ (バイト単位) が保存されます。

`dwFlags` [in]  
関数の動作を変更するためのフラグ。ゼロまたは以下の値を使用できます。    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
pszProperty が `NCRYPT_SECURITY_DESCR_PROPERTY` の場合、次のいずれかまたは組み合わせを使用します。    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)

## 戻り値
<a name="ksp-library-apis-get-property-return-value"></a>

この関数は、成功または失敗を示すステータスコードを返します。

一般的なリターンコードは次のとおりです。


****  

| リターンコード | 説明 | 
| --- | --- | 
|  ERROR\$1SUCCESS  |  オペレーションが正常に完了しました。  | 
|  NTE\$1INVALID\$1PARAMETER  |  1 つ以上のパラメータが無効です。  | 
|  NTE\$1FAIL  |  オペレーションを完了できませんでした。  | 
|  NTE\$1BAD\$1FLAGS  |  `dwFlags` パラメータに無効な値が含まれています。  | 
|  NTE\$1NOT\$1SUPPORTED  |  `pszAlgId` パラメータには、サポートされていない値が含まれています。  | 
|  NTE\$1INVALID\$1HANDLE  |  `hObject` のハンドルが無効です。  | 
|  NTE\$1BUFFER\$1TOO\$1SMALL  |  `cbOutput` パラメータが、戻り値を格納するには小さすぎます。  |