As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# NCryptGetProperty com o provedor de armazenamento de chaves (KSP)
<a name="ksp-library-apis-get-property"></a>

A função `NCryptGetProperty` recupera os valores das propriedades de um objeto de armazenamento de chaves.

## Parâmetros
<a name="ksp-library-apis-create-get-property-parameters"></a>

 `hObject` [in]   
 O identificador do objeto cuja propriedade você deseja recuperar. Você pode usar:  
+ Um identificador de provedor (`NCRYPT_PROV_HANDLE`)
+ Um identificador de chave (`NCRYPT_KEY_HANDLE`)

 `pszProperty ` [in]   
Um ponteiro para uma string Unicode terminada em nulo contendo o nome da propriedade a ser recuperada.   
Ao usar`NCRYPT_PROV_HANDLE`, o AWS CloudHSM Key Storage Provider (KSP) oferece suporte aos seguintes identificadores KSP:    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
Ao usar`NCRYPT_KEY_HANDLE`, o AWS CloudHSM Key Storage Provider (KSP) oferece suporte aos seguintes identificadores KSP:    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
Os valores são literais de string largos, conforme indicado pelo L antes do literal.

 `pbOutput` [out]   
O endereço de um buffer para armazenar o valor da propriedade. Especifique o tamanho do buffer usando `cbOutput`.  
Para determinar o tamanho do buffer necessário, defina esse parâmetro como NULL. A função armazena o tamanho necessário (em bytes) no local apontado por `pcbResult`.

 `cbOutput` [in]   
 O tamanho em bytes do buffer `pbOutput`.

`pcbResult` [out]  
Um ponteiro para uma variável DWORD que armazena o número de bytes copiados para o buffer `pbOutput`.  
Se `pbOutput` for NULL, isso armazenará o tamanho necessário (em bytes).

`dwFlags` [in]  
Sinalizadores para modificar o comportamento da função. Você pode usar zero ou:    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)
Quando pszProperty for `NCRYPT_SECURITY_DESCR_PROPERTY`, use um ou uma combinação de:    
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/ksp-library-apis-get-property.html)

## Valor de retorno
<a name="ksp-library-apis-get-property-return-value"></a>

A função retorna um código de status para indicar êxito ou falha.

Os códigos de retorno comuns incluem:


****  

| Código de retorno | Description | 
| --- | --- | 
|  ERROR\$1SUCCESS  |  A operação foi concluída com êxito.  | 
|  NTE\$1INVALID\$1PARAMETER  |  Um ou mais parâmetros não são válidos.  | 
|  NTE\$1FAIL  |  A operação não foi concluída.  | 
|  NTE\$1BAD\$1FLAGS  |  O parâmetro `dwFlags` contém um valor inválido.  | 
|  NTE\$1NOT\$1SUPPORTED  |  O parâmetro `pszAlgId` contém um valor que não é suportado.  | 
|  NTE\$1INVALID\$1HANDLE  |  O identificador em `hObject` não é válido.  | 
|  NTE\$1BUFFER\$1TOO\$1SMALL  |  O parâmetro `cbOutput` é muito pequeno para valores de retorno.  |