Função NCryptQueryProtectionDescriptorName (ncryptprotect.h)

A função NCryptQueryProtectionDescriptorName recupera a cadeia de caracteres de regra do descritor de proteção associada a um nome de exibição do descritor registrado.

Sintaxe

SECURITY_STATUS NCryptQueryProtectionDescriptorName(
  [in]      LPCWSTR pwszName,
  [out]     LPWSTR  pwszDescriptorString,
  [in, out] SIZE_T  *pcDescriptorString,
            DWORD   dwFlags
);

Parâmetros

[in] pwszName

O nome de exibição registrado para o descritor de proteção. Registre um nome chamando a função NCryptRegisterProtectionDescriptorName .

[out] pwszDescriptorString

Uma cadeia de caracteres Unicode terminada em nulo que contém a regra do descritor de proteção. Defina esse valor como NULL e defina o tamanho da cadeia de caracteres do descritor apontada pelo argumento pcDescriptorString como zero em sua chamada inicial para essa função. Para obter mais informações, consulte Comentários.

[in, out] pcDescriptorString

Ponteiro para uma variável que contém o número de caracteres na cadeia de caracteres recuperada no parâmetro pwszDescriptorString . Defina a variável como zero em sua chamada inicial para essa função. Para obter mais informações, consulte Comentários.

dwFlags

Sinalizador que especifica qual hive do Registro consultar para o nome registrado. Isso pode ser zero para procurar no hive HKEY_CURRENT_USER ou você pode especificar NCRYPT_MACHINE_KEY_FLAG para consultar o hive HKEY_LOCAL_MACHINE .

Retornar valor

Retorna um código status que indica o êxito ou a falha da função. Os códigos de retorno possíveis incluem, mas não se limitam a, o seguinte.

Código de retorno	Descrição
ERROR_SUCCESS	A função foi bem-sucedida.
NTE_INVALID_PARAMETER	O parâmetro pwszName não pode ser NULL e o valor apontado pelo parâmetro não pode ser uma cadeia de caracteres vazia.
NTE_BAD_FLAGS	O parâmetro dwFlags deve ser zero ou NCRYPT_MACHINE_KEY_FLAG.

Comentários

Para recuperar uma cadeia de caracteres de regra do descritor de proteção, você deve chamar essa função duas vezes. Na primeira vez que você chamar, defina o argumento pwszDescriptorString como NULL e o valor apontado pelo argumento pcDescriptorString como zero. Sua primeira chamada recupera o número de caracteres na cadeia de caracteres do descritor. Use esse número para alocar memória para a cadeia de caracteres e recuperar um ponteiro para o buffer alocado. Para recuperar a cadeia de caracteres, chame a função novamente usando o ponteiro .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ncryptprotect.h
Biblioteca	NCrypt.lib
DLL	NCrypt.dll

Confira também

Funções DPAPI do CNG

NCryptRegisterProtectionDescriptorName