ldap_parse_result 函数 (winldap.h)

ldap_parse_result 函数分析来自服务器的响应并返回相应的字段。

语法

WINLDAPAPI ULONG LDAPAPI ldap_parse_result(
  [in]            LDAP          *Connection,
  [in]            LDAPMessage   *ResultMessage,
  [out, optional] ULONG         *ReturnCode,
  [out, optional] PSTR          *MatchedDNs,
  [out, optional] PSTR          *ErrorMessage,
  [out, optional] PSTR          **Referrals,
  [out, optional] PLDAPControlA **ServerControls,
  [in]            BOOLEAN       Freeit
);

参数

[in] Connection

会话句柄。

[in] ResultMessage

由某个同步操作调用或异步操作 ldap_result 返回的 LDAP 操作的结果。

[out, optional] ReturnCode

指示生成原始结果消息的服务器操作的结果。 传递 NULL 可忽略此字段。

[out, optional] MatchedDNs

指向以 null 结尾的宽字符串的指针。 如果返回 LDAP_NO_SUCH_OBJECT,则此结果参数将填充一个可分辨名称,指示已识别请求中多少名称。 传递 NULL 可忽略此字段。

[out, optional] ErrorMessage

指向以 null 结尾的宽字符串的指针,该字符串包含 ResultMessage 参数中的错误消息字段的内容。 传递 NULL 可忽略此字段。

[out, optional] Referrals

指向以 null 结尾的宽字符串的指针,该字符串包含 ResultMessage 参数中的引用字段的内容,指示应重试请求的零个或多个备用 LDAP 服务器。 传递 NULL 可忽略此字段。

[out, optional] ServerControls

此结果参数使用从 ResultMessage 参数复制的已分配控件数组填充。

[in] Freeit

确定是否释放 ResultMessage 参数。 可以将任何非零值传递给 Freeit 参数,以在不再需要 ResultMessage 指针时释放它,也可以调用 ldap_msgfree 以释放结果。

返回值

如果函数成功,则返回值 LDAP_SUCCESS

如果函数失败,它将返回错误代码。 有关详细信息 ,请参阅返回值

注解

ldap_parse_result 函数遍历服务器响应链,查找要分析的结果消息。 如果要访问引用、匹配的可分辨名称或返回的服务器控件,请使用此函数。 函数跳过 类型为 LDAP_RES_SEARCH_ENTRYLDAP_RES_SEARCH_REFERENCE 的消息。

如果不再需要这些字符串,请通过调用 ldap_memfree释放 ErrorMessageMatchedDN 字符串。 通过调用 ldap_value_free 释放引荐数组。 通过调用 ldap_controls_free 释放 ServerControls

要求

   
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 winldap.h
Library Wldap32.lib
DLL Wldap32.dll

请参阅

函数

返回值

ldap_controls_free

ldap_memfree

ldap_msgfree

ldap_result

ldap_value_free