CryptSetProvider (Windows CE 5.0)

Article
09/14/2012

This function specifies the current user default cryptographic service provider (CSP). Typical applications do not use this function. It is intended for use solely by administrative applications.

If a current user's default provider is set, that default provider is acquired by any call by that user to the CryptAcquireContext function specifying a dwProvType provider type but not a CSP name.

BOOL CRYPTFUNC CryptSetProvider( LPCTSTRpszProvName,DWORDdwProvType);

Parameters

pszProvName
[in] Pointer to the null-terminated string that contains the name of the new default CSP. This must be a CSP installed on the computer.
dwProvType
[in] Specifies the provider type of the CSP defined in the pszProvName parameter.

Return Values

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.

Value	Description
ERROR_INVALID_HANDLE	One of the parameters specifies an invalid handle.
ERROR_INVALID_PARAMETER	One of the parameters contains an invalid value. This is most often an illegal pointer.
ERROR_NOT_ENOUGH_MEMORY	The operating system ran out of memory during the operation.
Error values returned from the RegCreateKeyEx function.	See RegCreateKeyEx.
Error values returned from the RegSetValueEx function.	See RegSetValueEx.

Remarks

Typical applications do not specify a CSP name when calling the CryptAcquireContext function; however, an application has the option of selecting a specific CSP. This approach gives the user the freedom to select a CSP with an appropriate level of security.

Because calling the CryptSetProvider function determines the CSP of a specified type used by all applications that run from that point on, this function must not be called without the consent of the user.

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

Example Code

HCRYPTPROV hProv = 0;

// Specify the default PROV_RSA_SIG provider. Note that this assumes
// that a CSP with a type of PROV_RSA_SIG and named "Joe's Provider"
// has already been installed.
if(!CryptSetProvider(TEXT("Joe's Provider"), PROV_RSA_SIG)) {
 printf("Error %x during CryptSetProvider!\n", GetLastError());
 return;
}

// Get a handle to the provider that you just made the default using CryptAcquireContext.
// For sample code, see CryptAcquireContext.
...
...

// Free the provider handle.
if(!CryptReleaseContext(hProv, 0)) {
 printf("Error %x during CryptReleaseContext!\n", GetLastError());
 return;
}

Requirements

OS Versions: Windows CE 2.10 and later.
Header: Wincrypt.h.
Link Library: Coredll.lib.