Edit

IEnroll2::GetAlgNameWStr method (xenroll.h)

  • Article

[This method is no longer available for use as of Windows Server 2008 and Windows Vista.]

The GetAlgNameWStr method retrieves the name of a cryptographic algorithm given its ID. The values retrieved by this method depend on the current cryptographic service provider (CSP). This method was first defined in the IEnroll2 interface.

Syntax

HRESULT GetAlgNameWStr(
  [in]  LONG   algID,
  [out] LPWSTR *ppwsz
);

Parameters

[in] algID

Value representing a cryptographic algorithm, as defined in Wincrypt.h. For example, CALG_MD2 is a defined algorithm identifier. For this method to be successful, the current CSP must support the algID algorithm.

[out] ppwsz

Upon success, pointer to a LPWSTR that represents the name of the algorithm specified by algID.

Return value

The return value is an HRESULT. A value of S_OK indicates success. If a CSP does not support this method or does not support the algID cryptographic algorithm, an error is returned.

Remarks

This method may be used to display the names of algorithms whose IDs are retrieved by calling EnumAlgs.

Constants for the cryptographic algorithms are defined in Wincrypt.h.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header xenroll.h
Library Uuid.lib
DLL Xenroll.dll

See also

IEnroll2