This function is used to specify the current user default cryptographic service provider (CSP). Typical applications do not use this function. It is intended for use solely by administrative applications.
After this function has been called, any calls this user subsequently makes to CryptAcquireContext specifying the dwProvType provider type but not a provider name result in the pszProvName provider being used.
At a Glance
| Header file: | Wincrypt.h |
| Windows CE versions: | 2.10 and later |
Syntax
BOOL CRYPTFUNC CryptSetProvider( LPCTSTR pszProvName,
DWORD dwProvType );
Parameters
pszProvName
[in] Pointer to the null-terminated string that contains the name of the new default CSP. This CSP should have already been 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 GetLastError. Common values for GetLastError are described in the following table. 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 usually specify a CSP name when calling the CryptAcquireContext function. This gives the users a certain amount of freedom in that they can select a CSP that has an appropriate level of security.
This means that a call to CryptSetProvider will often determine the CSP of a given type used by all applications that run from that point on. With this being the case, the CryptSetProvider function should never be called without the user's consent.
Windows CE does not support the ANSI version of this function.
Example
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.
if(!CryptAcquireContext(&hProv, NULL, NULL, PROV_RSA_SIG, 0)) {
printf("Error %x during CryptAcquireContext!\n", GetLastError());
return;
}
...
// Release the provider handle.
if(!CryptReleaseContext(hProv, 0)) {
printf("Error %x during CryptReleaseContext!\n", GetLastError());
return;
}
See Also