Edit

Share via

BCryptConfigureContextFunction function (bcrypt.h)

  • Article

[BCryptConfigureContextFunction is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

The BCryptConfigureContextFunction function sets the configuration information for the cryptographic function of an existing CNG context.

Syntax

NTSTATUS BCryptConfigureContextFunction(
  [in] ULONG                          dwTable,
  [in] LPCWSTR                        pszContext,
  [in] ULONG                          dwInterface,
  [in] LPCWSTR                        pszFunction,
  [in] PCRYPT_CONTEXT_FUNCTION_CONFIG pConfig
);

Parameters

[in] dwTable

Identifies the configuration table that the context exists in. This can be one of the following values.

Value Meaning
CRYPT_LOCAL
 The context exists in the local-machine configuration table.
CRYPT_DOMAIN
 This value is not available for use.

[in] pszContext

A pointer to a null-terminated Unicode string that contains the identifier of the context to set the cryptographic function configuration information for.

[in] dwInterface

Identifies the cryptographic interface to set the function configuration information for. This can be one of the following values.

Value Meaning
BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE
 Set the function configuration information in the list of asymmetric encryption functions.
BCRYPT_CIPHER_INTERFACE
 Set the function configuration information in the list of cipher functions.
BCRYPT_HASH_INTERFACE
 Set the function configuration information in the list of hash functions.
BCRYPT_RNG_INTERFACE
 Set the function configuration information in the list of random number generator functions.
BCRYPT_SECRET_AGREEMENT_INTERFACE
 Set the function configuration information in the list of secret agreement functions.
BCRYPT_SIGNATURE_INTERFACE
 Set the function configuration information in the list of signature functions.
NCRYPT_KEY_STORAGE_INTERFACE
 Set the function configuration information in the list of key storage functions.
NCRYPT_SCHANNEL_INTERFACE
 Set the function configuration information in the list of Schannel functions.
NCRYPT_SCHANNEL_SIGNATURE_INTERFACE
 Set the function configuration information in the list of signature suites that Schannel accepts for TLS 1.2.

Windows Vista and Windows Server 2008:  This value is not supported.

[in] pszFunction

A pointer to a null-terminated Unicode string that contains the identifier of the cryptographic function to set the configuration information for.

[in] pConfig

The address of a CRYPT_CONTEXT_FUNCTION_CONFIG structure that contains the new function configuration information.

Return value

Returns a status code that indicates the success or failure of the function.

Possible return codes include, but are not limited to, the following.

Return code Description
STATUS_SUCCESS
 The function was successful.
STATUS_INVALID_PARAMETER
 One or more parameters are not valid.
STATUS_NO_MEMORY
 A memory allocation failure occurred.

Remarks

BCryptConfigureContextFunction can be called only in user mode.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header bcrypt.h
Library Bcrypt.lib
DLL Bcrypt.dll

See also

CRYPT_CONTEXT_FUNCTION_CONFIG