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

Artículo
03/04/2024

[Este método ya no está disponible para su uso a partir de Windows Server 2008 y Windows Vista.]

El método GetAlgName recupera el nombre de un algoritmo criptográfico según su identificador. Los valores recuperados por este método dependen del proveedor de servicios criptográficos (CSP) actual. Este método se definió por primera vez en la interfaz ICEnroll3 .

Sintaxis

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

Parámetros

[in] algID

Valor que representa un algoritmo criptográfico, tal como se define en Wincrypt.h. Por ejemplo, CALG_MD2 es un identificador de algoritmo definido. Para que este método se realice correctamente, el CSP actual debe admitir el algoritmo algID .

[out] pbstr

Tras la operación correcta, un puntero a un BSTR que representa el nombre del algoritmo especificado por algID. Cuando haya terminado de usar el BSTR, áurelo llamando a la función SysFreeString .

Valor devuelto

C++

El valor devuelto es hrESULT. Un valor de S_OK indica que se ha realizado correctamente. Si un CSP no admite este método o no admite el algoritmo criptográfico algID , se devuelve un error.

VB

El valor devuelto es una cadena que representa el nombre del algoritmo especificado por algID. Si un CSP no admite este método, se devuelve un error.

Comentarios

Este método se puede usar para mostrar los nombres de los algoritmos cuyos identificadores se recuperan mediante una llamada a EnumAlgs.

Las constantes para los algoritmos criptográficos se definen en Wincrypt.h.

Ejemplos

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	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	xenroll.h
Library	Uuid.lib
Archivo DLL	Xenroll.dll