Export (0) Print
Expand All

BCryptSetProperty function

The BCryptSetProperty function sets the value of a named property for a CNG object.

Syntax


NTSTATUS WINAPI BCryptSetProperty(
  _Inout_  BCRYPT_HANDLE hObject,
  _In_     LPCWSTR pszProperty,
  _In_     PUCHAR pbInput,
  _In_     ULONG cbInput,
  _In_     ULONG dwFlags
);

Parameters

hObject [in, out]

A handle that represents the CNG object to set the property value for.

pszProperty [in]

A pointer to a null-terminated Unicode string that contains the name of the property to set. This can be one of the predefined Cryptography Primitive Property Identifiers or a custom property identifier.

pbInput [in]

The address of a buffer that contains the new property value. The cbInput parameter contains the size of this buffer.

cbInput [in]

The size, in bytes, of the pbInput buffer.

dwFlags [in]

A set of flags that modify the behavior of this function. No flags are defined for this function.

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 codeDescription
STATUS_SUCCESS

The function was successful.

STATUS_INVALID_HANDLE

The handle in the hObject parameter is not valid.

STATUS_INVALID_PARAMETER

One or more parameters are not valid.

STATUS_NOT_SUPPORTED

The named property specified by the pszProperty parameter is not supported or is read-only.

 

Remarks

Depending on what processor modes a provider supports, BCryptSetProperty can be called either from user mode or kernel mode. Kernel mode callers can execute either at PASSIVE_LEVEL IRQL or DISPATCH_LEVEL IRQL. If the current IRQL level is DISPATCH_LEVEL, any pointers passed to BCryptSetProperty must refer to nonpaged (or locked) memory. If the object specified in the hObject parameter is a handle, it must have been opened by using the BCRYPT_PROV_DISPATCH flag.

To call this function in kernel mode, use Cng.lib, which is part of the Driver Development Kit (DDK). For more information, see WDK and Developer Tools.

Windows Server 2008 and Windows Vista:  To call this function in kernel mode, use Ksecdd.lib.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Bcrypt.h

Library

Bcrypt.lib

DLL

Bcrypt.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft