Função CryptSetKeyIdentifierProperty (wincrypt.h)

Artigo
03/03/2024

Importante Essa API foi preterida. O software novo e existente deve começar a usar APIs de Próxima Geração de Criptografia. A Microsoft pode remover essa API em versões futuras.

A função CryptSetKeyIdentifierProperty define a propriedade de um identificador de chave especificado. Essa função pode definir a propriedade no computador identificado em pwszComputerName.

Sintaxe

BOOL CryptSetKeyIdentifierProperty(
  [in]  const CRYPT_HASH_BLOB *pKeyIdentifier,
  [in]  DWORD                 dwPropId,
  [in]  DWORD                 dwFlags,
  [in]  LPCWSTR               pwszComputerName,
  [in]  void                  *pvReserved,
  [out] const void            *pvData
);

Parâmetros

[in] pKeyIdentifier

Um ponteiro para um CRYPT_HASH_BLOB que contém o identificador de chave.

[in] dwPropId

Identifica a propriedade a ser definida. O valor de dwPropId determina o tipo e o conteúdo do parâmetro pvData . Qualquer ID de propriedade de certificado pode ser usada. CERT_KEY_PROV_INFO_PROP_ID é a propriedade de maior interesse.

[in] dwFlags

Os sinalizadores a seguir podem ser definidos. Eles podem ser combinados com uma operação OR bit a bit.

Valor	Significado
CRYPT_KEYID_MACHINE_FLAG	Define a propriedade de LocalMachine (se pwszComputerName for NULL) ou computador remoto (se pwszComputerName não for NULL). Para obter mais informações, consulte pwszComputerName.
CRYPT_KEYID_DELETE_FLAG	O identificador de chave e todas as suas propriedades são excluídos.
CRYPT_KEYID_SET_NEW_FLAG	Define uma nova propriedade de identificador de chave. Se a propriedade já existir, a tentativa falhará e FALSE será retornado com o último código de erro definido como CRYPT_E_EXISTS.

[in] pwszComputerName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome de um computador remoto que tem o identificador de chave em que as propriedades estão definidas. Se CRYPT_KEYID_MACHINE_FLAG sinalizador estiver definido, o procurará no computador remoto uma lista de identificadores de chave. Se o computador local deve ser definido e não um computador remoto, defina pwszComputerName como NULL.

[in] pvReserved

Reservado para uso futuro e deve ser NULL.

[out] pvData

Se dwPropId for CERT_KEY_PROV_INFO_PROP_ID, pvData apontará para uma estrutura CRYPT_KEY_PROV_INFO que contém a propriedade do identificador de chave.

Se dwPropId não for CERT_KEY_PROV_INFO_PROP_ID, pvData apontará para uma estrutura de CRYPT_DATA_BLOB que contém a propriedade do identificador de chave.

Definir pvData como NULL exclui a propriedade .

Retornar valor

Se a função for bem-sucedida, o valor retornado será diferente de zero (TRUE).

Se a função falhar, o valor retornado será zero (FALSE). Para obter informações de erro estendidas, chame GetLastError.

Nota Se CRYPT_KEYID_SET_NEW_FLAG estiver definido e a propriedade já existir, FALSE será retornado com o último código de erro definido como CRYPT_E_EXISTS.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wincrypt.h
Biblioteca	Crypt32.lib
DLL	Crypt32.dll

Confira também

CryptEnumKeyIdentifierProperties

CryptGetKeyIdentifierProperty

Funções de identificador de chave

Compartilhar via