Método ICEnroll3::GetAlgName (xenroll.h)

Artigo
03/13/2024

[Esse método não está mais disponível para uso desde o Windows Server 2008 e o Windows Vista.]

O método GetAlgName recupera o nome de um algoritmo criptográfico, considerando sua ID. Os valores recuperados por esse método dependem do CSP ( provedor de serviços criptográficos ) atual. Esse método foi definido pela primeira vez na interface ICEnroll3 .

Sintaxe

HRESULT GetAlgName(
  [in]  LONG algID,
  [out] BSTR *pbstr
);

Parâmetros

[in] algID

Um valor que representa um algoritmo criptográfico, conforme definido em Wincrypt.h. Por exemplo, CALG_MD2 é um identificador de algoritmo definido. Para que esse método seja bem-sucedido, o CSP atual deve dar suporte ao algoritmo algID .

[out] pbstr

Após o êxito, um ponteiro para um BSTR que representa o nome do algoritmo especificado por algID. Quando terminar de usar o BSTR, libere-o chamando a função SysFreeString .

Retornar valor

C++

O valor retornado é um HRESULT. Um valor de S_OK indica êxito. Se um CSP não der suporte a esse método ou não der suporte ao algoritmo criptográfico algID , um erro será retornado.

VB

O valor retornado é uma cadeia de caracteres que representa o nome do algoritmo especificado por algID. Se um CSP não der suporte a esse método, um erro será retornado.

Comentários

Esse método pode ser usado para exibir os nomes de algoritmos cujas IDs são recuperadas chamando EnumAlgs.

As constantes para os algoritmos criptográficos são definidas em Wincrypt.h.

Exemplos

BSTR      bstrAlgName = NULL;

HRESULT   hr;

// Retrieve the algorithm name.
// dwAlgID is a DWORD variable for an algorithm ID.
hr = pEnroll->GetAlgName( dwAlgID, &bstrAlgName);
if (FAILED(hr))
    printf("Failed GetAlgName [%x]\n", hr);
else
    printf("AlgID: %d Name: %S\n", dwAlgID, bstrAlgName );

// Free BSTR resource.
if ( NULL != bstrAlgName )
{
    SysFreeString( bstrAlgName );
    bstrAlgName = NULL;
}

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	xenroll.h
Biblioteca	Uuid.lib
DLL	Xenroll.dll