SaslGetContextOption-Funktion (sspi.h)

  • Artikel

Die SaslGetContextOption-Funktion ruft die angegebene Eigenschaft des angegebenen SASL-Kontexts ab.

Syntax

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

Parameter

[in] ContextHandle

Handle des SASL-Kontexts.

[in] Option

Eigenschaft, die vom SASL-Kontext zurückgegeben werden soll. In der folgenden Tabelle sind die möglichen Werte aufgeführt.

Wert Bedeutung
SASL_OPTION_AUTHZ_PROCESSING
 Datentyp des Puffers: ULONG

Status der SASL-Verarbeitung des von der SASL-Anwendung bereitgestellten Authz-Werts. Die gültigen Zustände für die Verarbeitung sind Sasl_AuthZIDForbidden und Sasl_AuthZIDProcessed.
SASL_OPTION_AUTHZ_STRING
 Datentyp des Puffers: Array von Binärzeichen

Zeichenfolge, die vom SASL-Client an den Server übergeben wird. Wenn der AuthZ_Processing Zustand Sasl_AuthZIDForbidden ist, wird der Rückgabewert SEC_E_UNSUPPORTED_FUNCTION zurückgegeben.
SASL_OPTION_RECV_SIZE
 Datentyp des Puffers: ULONG

Maximale Größe des Empfangspuffers auf dem lokalen Computer.
SASL_OPTION_SEND_SIZE
 Datentyp des Puffers: ULONG

Maximale Nachrichtendatengröße, die übertragen werden kann. Dieser Wert ist die maximale Puffergröße, die an den SASL-Remoteprozess übertragen werden kann, abzüglich der Blockgröße, der Anhängergröße und der maximalen Signaturgröße.

[out] Value

Ein Zeiger auf einen Puffer, der die angeforderte Eigenschaft empfängt. Den Datentyp des Puffers für jeden Wert des Option-Parameters finden Sie im Parameter Option .

[out] Size

Die Größe des Puffers, der durch den Value-Parameter angegeben wird, in Byte.

[out, optional] Needed

Ein Zeiger auf einen LONG-Wert ohne Vorzeichen, der den Wert zurückgibt, wenn der durch den Value-Parameter angegebene Puffer nicht groß genug ist, um den Datenwert der eigenschaft zu enthalten, die durch den Parameter Option angegeben wird.

Rückgabewert

Wenn der Aufruf erfolgreich abgeschlossen wurde, gibt diese Funktion SEC_E_OK zurück. In der folgenden Tabelle sind einige mögliche Fehlerrückgabewerte aufgeführt.

Rückgabecode Beschreibung
SEC_E_BUFFER_TOO_SMALL
 Der durch den Value-Parameter angegebene Puffer ist nicht groß genug, um den Datenwert der durch den Parameter Option angegebenen Eigenschaft zu enthalten.
SEC_E_INVALID_HANDLE
 Das vom ContextHandle-Parameter angegebene SASL-Kontexthandle wurde in der SASL-Liste nicht gefunden.
SEC_E_UNSUPPORTED_FUNCTION
 Die im Parameter Option angegebene Option ist ungültig.

Anforderungen

   
Unterstützte Mindestversion (Client) Nicht unterstützt
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile sspi.h (einschließlich Security.h)
Bibliothek Secur32.lib
DLL Secur32.dll