CryptEnumProviders

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the first or next available cryptographic service provider (CSP). Used in a loop, this function can retrieve in sequence all of the CSPs available on a computer.

Syntax

BOOL WINAPI CryptEnumProviders( 
  DWORD dwIndex, 
  DWORD* pdwReserved, 
  DWORD dwFlags, 
  DWORD* pdwProvType, 
  LPTSTR pszProvName, 
  DWORD* pcbProvName
);

Parameters

• dwIndex
  [in] Index of the next provider to be enumerated.

• pdwReserved
  [in] Reserved for future use and must be set to NULL.

• dwFlags
  [in] Reserved for future use and must be set to zero.

• pdwProvType
  [in] Pointer to the DWORD value that designates the type of the enumerated provider.

• pszProvName
  [out] Pointer to a buffer that receives a null-terminated string from the enumerated provider.

  This parameter can be NULL to set the size of the name for memory allocation purposes.

• pcbProvName
  [in, out] On input, pointer to a DWORD value that specifies the size, in bytes, of the buffer pointed to by the pszProvName parameter. On output, the variable pointed to by this parameter contains the number of bytes stored in the buffer.

  When processing the data returned in the buffer, applications must use the actual size of the data returned. The actual size may be slightly smaller than the size of the buffer specified on input. On input, buffer sizes are usually specified large enough to ensure that the largest possible output data will fit in the buffer. On output, the variable pointed to by this parameter is updated to reflect the actual size of the data copied to the buffer.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call the GetLastError function.

The following table shows the common values for the GetLastError function. The error values prefaced by NTE are generated by the particular CSP you are using.

Remarks

This function enumerates the providers on a machine. The provider types may be enumerated by using the CryptEnumProviderTypes function.

If the registry does not contain the provider type, the CryptEnumProviders function call fails with ERROR_INVALID_PARAMETER.

Windows Embedded CE does not support the ANSI version of this function.

Example Code

long i;
LPTSTR pszName;
DWORD dwType;
DWORD cbName;
DWORD dwErr;
 
// Loop through enumerating provider types.
for (i=0;;i++)
{
if (!CryptEnumProviders(
 i, // in- dwIndex
 NULL, // in- pdwReserved- set to NULL
 0, // in- dwFlags- set to 0
 &dwType, // out- pdwProvType
 NULL, // out- pszProvName- NULL on the first call
 &cbName // in, out-pcbProvName
 ))
 {if (ERROR_NO_MORE_ITEMS != (dwErr = GetLastError()))
 {printf("ERROR - CryptEnumProviders : %X\n", dwErr);
 }
 break;
 }
if (NULL == (pszName = (LPTSTR)LocalAlloc(LMEM_ZEROINIT, cbName)))
 {printf("ERROR - LocalAlloc failed!\n");
 }
if (!CryptEnumProviders(
 i,
 NULL,
 0,
 &dwType,
 pszName,
 &cbName // pcbProvName- size of pszName
 ))
 {if (ERROR_NO_MORE_ITEMS != (dwErr = GetLastError()))
 {printf("ERROR - CryptEnumProviders : %X\n", dwErr);
 }
 LocalFree(pszName);
 break;
 }
printf ("Provider %s is type %d\n", pszName, dwType);
LocalFree(pszName);
} 

Requirements

See Also

Reference

CryptEnumProviderTypes