SaslGetContextOption function

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_opt_ PULONG      Needed
);

Parameters

ContextHandle [in]

Handle of the SASL context.

Option [in]

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.

 

Value [out]

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.

Size [out]

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

Needed [out, optional]

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.

Requirements