SslGetProviderProperty function

The SslGetProviderProperty function retrieves the value of a specified provider property.

Syntax


SECURITY_STATUS WINAPI SslGetProviderProperty(
  _In_     NCRYPT_PROV_HANDLE hSslProvider,
  _In_     LPCWSTR pszProperty,
  _Out_    PBYTE ppbOutput,
  _Out_    DWORD *pcbOutput,
  _Inout_  PVOID *ppEnumState,
  _In_     DWORD dwFlags
);

Parameters

hSslProvider [in]

The handle of the Secure Sockets Layer protocol (SSL) provider for which to retrieve the property.

pszProperty [in]

A pointer to a null-terminated Unicode string that contains the name of the property to retrieve.

ppbOutput [out]

The address of 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.

ppEnumState [in, out]

The address of a VOID pointer that receives enumeration state information that is used in subsequent calls to this function. This information only has meaning to the SSL provider and is opaque to the caller. The SSL provider uses this information to determine which item is next in the enumeration. If the variable pointed to by this parameter contains NULL, the enumeration is started from the beginning.

The caller of the function must free this memory by calling the SslFreeBuffer function.

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_NO_MEMORY
0x8009000EL

Not enough memory is available to allocate necessary buffers.

NTE_INVALID_HANDLE
0x80090026L

The hSslProvider handle 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