Edit

Share via

SaslGetContextOption function (sspi.h)

  • Article

The SaslGetContextOption function retrieves the specified property of the specified SASL context.

Syntax

SECURITY_STATUS SEC_ENTRY SaslGetContextOption(
  [in]            PCtxtHandle ContextHandle,
  [in]            ULONG       Option,
  [out]           PVOID       Value,
  [out]           ULONG       Size,
  [out, optional] PULONG      Needed
);

Parameters

[in] ContextHandle

Handle of the SASL context.

[in] Option

Property to return from the SASL context. The following table lists the possible values.

Value Meaning
SASL_OPTION_AUTHZ_PROCESSING
 Data type of buffer: ULONG

State of SASL processing of the Authz value provided by the SASL application. The valid states for processing are Sasl_AuthZIDForbidden and Sasl_AuthZIDProcessed.
SASL_OPTION_AUTHZ_STRING
 Data type of buffer: Array of binary characters

String of characters passed from the SASL client to the server. If the AuthZ_Processing state is Sasl_AuthZIDForbidden, the return value SEC_E_UNSUPPORTED_FUNCTION is returned.
SASL_OPTION_RECV_SIZE
 Data type of buffer: ULONG

Maximum size of the receiving buffer on the local computer.
SASL_OPTION_SEND_SIZE
 Data type of buffer: ULONG

Maximum message data size that can be transmitted. This value is the maximum buffer size that can be transmitted to the remote SASL process minus the block size, the trailer size, and the maximum signature size.

[out] Value

A pointer to a buffer that receives the requested property. For the data type of the buffer for each value of the Option parameter, see the Option parameter.

[out] Size

The size, in bytes, of the buffer specified by the Value parameter.

[out, optional] Needed

A pointer to an unsigned LONG value that returns the value if the buffer specified by the Value parameter is not large enough to contain the data value of the property specified by the Option parameter.

Return value

If the call is completed successfully, this function returns SEC_E_OK. The following table shows some possible error return values.

Return code Description
SEC_E_BUFFER_TOO_SMALL
 The buffer specified by the Value parameter is not large enough to contain the data value of the property specified by the Option parameter.
SEC_E_INVALID_HANDLE
 The SASL context handle specified by the ContextHandle parameter was not found in the SASL list.
SEC_E_UNSUPPORTED_FUNCTION
 The option specified in the Option parameter is not valid.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header sspi.h (include Security.h)
Library Secur32.lib
DLL Secur32.dll