Export (0) Print
Expand All
Expand Minimize

ldap_parse_extended_result function

The ldap_parse_extended_result parses the results of an LDAP extended operation.

Syntax


ULONG ldap_parse_extended_result(
  _In_   LDAP Connection,
  _In_   LDAPMessage *ResultMessage,
  _Out_  PCHAR *ResultOID,
  _Out_  struct berval **ResultData,
  _In_   BOOLEAN Freeit
);

Parameters

Connection [in]

The session handle.

ResultMessage [in]

A pointer to an LDAPMessage structure as returned by ldap_result in response to an extended operation request.

ResultOID [out]

A pointer to a null-terminated string that contains the dotted object identifier (OID) text string of the server's response message. This is normally the same OID as the one naming the request that was originally passed to the server by ldap_extended_operation.

ResultData [out]

The arbitrary data returned by the extended operation (if NULL, no data is returned by the server).

Freeit [in]

Determines whether the ResultMessage parameter is freed. You can pass any nonzero value to the Freeit parameter to free the ResultMessage pointer when it is no longer needed, or you can call ldap_msgfree to free the result later.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

When a server processes an extended operation request generated by ldap_extended_operation, it returns an LDAP message along with an LDAP_RES_EXTENDED return code. Use ldap_parse_extended_result to parse this result message, which returns both the text OID of the originating message in ResultOID and any arbitrary data generated by the extended operation in ResultData.

When they are no longer needed, free the ResultOID string and the ResultData buffer by calling ldap_memfree.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

Unicode and ANSI names

ldap_parse_extended_resultW (Unicode) and ldap_parse_extended_resultA (ANSI)

See also

Functions
LDAPMessage
ldap_extended_operation
ldap_result
ldap_memfree
ldap_msgfree
Return Values

 

 

Show:
© 2014 Microsoft