WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsILDAPMessage

IID:973ff50f-2002-4f0c-b57d-2242156139a2
Inherits From:nsISupports

This interface is implemented by the following components:

Constants

Result of a bind operation
PRInt32 RES_BIND = 97
An entry found in an search operation.
PRInt32 RES_SEARCH_ENTRY = 100
An LDAPv3 search reference (a referral to another server)
PRInt32 RES_SEARCH_REFERENCE = 115
The result of a search operation (i.e. the search is done; no more entries to follow).
PRInt32 RES_SEARCH_RESULT = 101
The result of a modify operation.
PRInt32 RES_MODIFY = 103
The result of an add operation
PRInt32 RES_ADD = 105
The result of a delete operation
PRInt32 RES_DELETE = 107
The result of an modify DN operation
PRInt32 RES_MODDN = 109
The result of a compare operation
PRInt32 RES_COMPARE = 111
The result of an LDAPv3 extended operation
PRInt32 RES_EXTENDED = 120

Properties

readonly AUTF8String dn

The Distinguished Name of the entry associated with this message.

readonly PRInt32 errorCode

The result code (aka lderrno) for this message.

IDL definitions for these constants live in nsILDAPErrors.idl.

readonly AUTF8String errorMessage

Additional error information optionally sent by the server.

readonly AUTF8String matchedDn

In LDAPv3, when the server returns any of the following errors: NO_SUCH_OBJECT, ALIAS_PROBLEM, INVALID_DN_SYNTAX, ALIAS_DEREF_PROBLEM, it also returns the closest existing DN to the entry requested.

readonly nsILDAPOperation operation

The operation this message originated from

readonly PRInt32 type

The result type of this message. Possible types listed below, the values chosen are taken from the draft-ietf-ldapext-ldap-c-api-04.txt and are the same ones used in the ldap.h include file from the Mozilla LDAP C SDK.

Methods

void getAttributes ( out PRUint32 count , out arrayof char* attributes ) void getBinaryValues ( char* attr , out PRUint32 count , out nsILDAPBERValue values ) void getValues ( char* attr , out PRUint32 count , out arrayof PRUnichar* values ) PRUnichar* toUnicode ( )

void getAttributes ( out PRUint32 count , out arrayof char* attributes )

Get all the attributes in this message.

Arguments:
count
attributes
Returns:
array of all attributes in the current message

void getBinaryValues ( char* attr , out PRUint32 count , out nsILDAPBERValue values )

Get an array of all the attribute values in this message (a wrapper around the LDAP C SDK's get_values_len()).

Arguments:
attr: The attribute whose values are to be returned
count: Number of values in the outbound array.
values: Array of nsILDAPBERValue objects

void getValues ( char* attr , out PRUint32 count , out arrayof PRUnichar* values )

Get an array of all the attribute values in this message.

Arguments:
attr: The attribute whose values are to be returned
count: Number of values in the outbound array.
values: Array of values

PRUnichar* toUnicode ( )

Get an LDIF-like string representation of this message

Returns:
unicode encoded string representation.

References

This interface is passed as an argument to the following methods:

nsIAbLDAPAttributeMap.setCardPropertiesFromLDAPMessage, nsIAbLDAPCard.setMetaProperties, nsILDAPAutoCompFormatter.format, nsILDAPMessageListener.onLDAPMessage

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com