SslGetKeyProperty function

The SslGetKeyProperty function retrieves the value of a named property for a Secure Sockets Layer protocol (SSL) provider key object.

Syntax


SECURITY_STATUS WINAPI SslGetKeyProperty(
  _In_   NCRYPT_KEY_HANDLE hKey,
  _In_   LPCWSTR pszProperty,
  _Out_  PBYTE ppbOutput,
  _Out_  DWORD *pcbOutput,
  _In_   DWORD dwFlags
);

Parameters

hKey [in]

The handle of the SSL provider.

pszProperty [in]

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

ppbOutput [out]

A pointer to a buffer that receives the property value. The caller of the function must free this buffer by calling the SslFreeBuffer function.

pcbOutput [out]

The size, in bytes, of the pbOutput buffer.

dwFlags [in]

This parameter is reserved for future use.

Return value

If the function succeeds, it returns zero.

If the function fails, it returns a nonzero error value.

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

Return code/valueDescription
NTE_INVALID_HANDLE
0x80090026L

One of the provided handles is not valid.

NTE_INVALID_PARAMETER
0x80090027L

One of the supplied parameters is not valid.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Sslprovider.h

DLL

Ncrypt.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.