ICEnroll3::GetAlgName-Methode (xenroll.h)
[Diese Methode steht ab Windows Server 2008 und Windows Vista nicht mehr zur Verfügung.]
Die GetAlgName-Methode ruft den Namen eines kryptografischen Algorithmus unter Berücksichtigung seiner ID ab. Die von dieser Methode abgerufenen Werte hängen vom aktuellen Kryptografiedienstanbieter (CSP) ab. Diese Methode wurde zuerst in der ICEnroll3-Schnittstelle definiert.
Syntax
HRESULT GetAlgName(
[in] LONG algID,
[out] BSTR *pbstr
);
Parameter
[in] algID
Ein Wert, der einen kryptografischen Algorithmus darstellt, wie in Wincrypt.h definiert. Beispielsweise ist CALG_MD2 ein definierter Algorithmusbezeichner. Damit diese Methode erfolgreich ist, muss der aktuelle CSP den algID-Algorithmus unterstützen.
[out] pbstr
Bei Erfolg ein Zeiger auf einen BSTR , der den Namen des von algID angegebenen Algorithmus darstellt. Wenn Sie die Verwendung des BSTR abgeschlossen haben, geben Sie ihn frei, indem Sie die SysFreeString-Funktion aufrufen.
Rückgabewert
C++
Der Rückgabewert ist ein HRESULT. Ein Wert von S_OK gibt den Erfolg an. Wenn ein CSP diese Methode nicht unterstützt oder den kryptografischen Algorithmus algID nicht unterstützt, wird ein Fehler zurückgegeben.VB
Der Rückgabewert ist eine Zeichenfolge, die den Namen des algorithmus darstellt, der durch algID angegeben wird. Wenn ein CSP diese Methode nicht unterstützt, wird ein Fehler zurückgegeben.Hinweise
Diese Methode kann verwendet werden, um die Namen von Algorithmen anzuzeigen, deren IDs durch aufrufen von EnumAlgs abgerufen werden.
Konstanten für die kryptografischen Algorithmen werden in Wincrypt.h definiert.
Beispiele
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;
}
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2003 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | xenroll.h |
| Bibliothek | Uuid.lib |
| DLL | Xenroll.dll |