Função NCryptEnumKeys (ncrypt.h)

A função NCryptEnumKeys obtém os nomes das chaves armazenadas pelo provedor.

Sintaxe

SECURITY_STATUS NCryptEnumKeys(
  [in]           NCRYPT_PROV_HANDLE hProvider,
  [in, optional] LPCWSTR            pszScope,
  [out]          NCryptKeyName      **ppKeyName,
  [in, out]      PVOID              *ppEnumState,
  [in]           DWORD              dwFlags
);

Parâmetros

[in] hProvider

O identificador do provedor de armazenamento de chaves para o qual enumerar as chaves. Esse identificador é obtido com a função NCryptOpenStorageProvider .

[in, optional] pszScope

Esse parâmetro não é usado no momento e deve ser NULL.

[out] ppKeyName

O endereço de um ponteiro para uma estrutura NCryptKeyName que recebe o nome da chave recuperada. Quando o aplicativo terminar de usar essa memória, libere-o chamando a função NCryptFreeBuffer .

[in, out] ppEnumState

O endereço de um ponteiro VOID que recebe informações de estado de enumeração usadas em chamadas subsequentes para essa função. Essas informações só têm significado para o provedor de armazenamento de chaves e são opacas para o chamador. O provedor de armazenamento de chaves usa essas informações para determinar qual item é o próximo na enumeração. Se a variável apontada por esse parâmetro contiver NULL, a enumeração será iniciada desde o início.

Quando essa memória não for mais necessária, ela deverá ser liberada passando esse ponteiro para a função NCryptFreeBuffer .

[in] dwFlags

Sinalizadores que modificam o comportamento da função. Isso pode ser zero ou uma combinação de um ou mais dos valores a seguir.

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.

Comentários

Essa função recupera apenas um item cada vez que é chamada. O estado da enumeração é armazenado na variável apontada pelo parâmetro ppEnumState , portanto, isso deve ser preservado entre chamadas para essa função. Quando a última chave armazenada pelo provedor tiver sido recuperada, essa função retornará NTE_NO_MORE_ITEMS da próxima vez que for chamada. Para iniciar a enumeração, defina a variável apontada pelo parâmetro ppEnumState como NULL, libere a memória apontada pelo parâmetro ppKeyName , se não for NULL, e chame essa função novamente.

Um serviço não deve chamar essa função de sua Função StartService. Se um serviço chamar essa função de sua função StartService, um deadlock poderá ocorrer e o serviço poderá parar de responder.

Requisitos