Public Member Functions | Public Attributes

nsILDAPMessage Interface Reference

import "nsILDAPMessage.idl";

Collaboration diagram for nsILDAPMessage:

List of all members.

Public Member Functions

void getAttributes (out unsigned long count,[retval, array, size_is(count)] out string aAttributes)
 Get all the attributes in this message.
void getValues (in string attr, out unsigned long count,[retval, array, size_is(count)] out wstring values)
 Get an array of all the attribute values in this message.
wstring toUnicode ()
 get an LDIF-like string representation of this message
void getBinaryValues (in string attr, out unsigned long count,[retval, array, size_is(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()).

Public Attributes

readonly attribute AUTF8String dn
 The Distinguished Name of the entry associated with this message.
readonly attribute nsILDAPOperation operation
 The operation this message originated from.
readonly attribute long errorCode
 The result code (aka lderrno) for this message.
readonly attribute long type
 The result type of this message.
const long RES_BIND = 0x61
 Result of a bind operation.
const long RES_SEARCH_ENTRY = 0x64
 An entry found in an search operation.
const long RES_SEARCH_REFERENCE = 0x73
 An LDAPv3 search reference (a referral to another server).
const long RES_SEARCH_RESULT = 0x65
 The result of a search operation (i.e.
const long RES_MODIFY = 0x67
 The result of a modify operation.
const long RES_ADD = 0x69
 The result of an add operation.
const long RES_DELETE = 0x6B
 The result of a delete operation.
const long RES_MODDN = 0x6D
 The result of an modify DN operation.
const long RES_COMPARE = 0x6F
 The result of a compare operation.
const long RES_EXTENDED = 0x78
 The result of an LDAPv3 extended operation.
readonly attribute AUTF8String errorMessage
 Additional error information optionally sent by the server.
readonly attribute 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.

Member Function Documentation

void nsILDAPMessage::getAttributes ( out unsigned long  count,
[retval, array, size_is(count)] out string  aAttributes 
)

Get all the attributes in this message.

Exceptions:
NS_ERROR_OUT_OF_MEMORY 
NS_ERROR_ILLEGAL_VALUE null pointer passed in
NS_ERROR_UNEXPECTED bug or memory corruption
NS_ERROR_LDAP_DECODING_ERROR problem during BER decoding
Returns:
array of all attributes in the current message
void nsILDAPMessage::getBinaryValues ( in string  attr,
out unsigned long  count,
[retval, array, size_is(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()).

Parameters:
attr The attribute whose values are to be returned
count Number of values in the outbound array.
values Array of nsILDAPBERValue objects
Exceptions:
NS_ERROR_UNEXPECTED Bug or memory corruption
NS_ERROR_LDAP_DECODING_ERROR Attribute not found or other decoding error.
NS_ERROR_OUT_OF_MEMORY 
void nsILDAPMessage::getValues ( in string  attr,
out unsigned long  count,
[retval, array, size_is(count)] out wstring  values 
)

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

Parameters:
attr The attribute whose values are to be returned
count Number of values in the outbound array.
values Array of values
Exceptions:
NS_ERROR_UNEXPECTED Bug or memory corruption
NS_ERROR_LDAP_DECODING_ERROR Attribute not found or other decoding error.
NS_ERROR_OUT_OF_MEMORY 
wstring nsILDAPMessage::toUnicode (  ) 

get an LDIF-like string representation of this message

Returns:
unicode encoded string representation.

Member Data Documentation

readonly attribute AUTF8String nsILDAPMessage::dn

The Distinguished Name of the entry associated with this message.

Exceptions:
NS_ERROR_OUT_OF_MEMORY ran out of memory
NS_ERROR_ILLEGAL_VALUE null pointer passed in
NS_ERROR_LDAP_DECODING_ERROR problem during BER-decoding
NS_ERROR_UNEXPECTED bug or memory corruption
readonly attribute long nsILDAPMessage::errorCode

The result code (aka lderrno) for this message.

IDL definitions for these constants live in nsILDAPErrors.idl.

Exceptions:
NS_ERROR_ILLEGAL_VALUE null pointer passed in
readonly attribute AUTF8String nsILDAPMessage::errorMessage

Additional error information optionally sent by the server.

readonly attribute AUTF8String nsILDAPMessage::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.

The operation this message originated from.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to getter
const long nsILDAPMessage::RES_ADD = 0x69

The result of an add operation.

const long nsILDAPMessage::RES_BIND = 0x61

Result of a bind operation.

const long nsILDAPMessage::RES_COMPARE = 0x6F

The result of a compare operation.

const long nsILDAPMessage::RES_DELETE = 0x6B

The result of a delete operation.

const long nsILDAPMessage::RES_EXTENDED = 0x78

The result of an LDAPv3 extended operation.

const long nsILDAPMessage::RES_MODDN = 0x6D

The result of an modify DN operation.

const long nsILDAPMessage::RES_MODIFY = 0x67

The result of a modify operation.

An entry found in an search operation.

An LDAPv3 search reference (a referral to another server).

The result of a search operation (i.e.

the search is done; no more entries to follow).

readonly attribute long nsILDAPMessage::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.

Exceptions:
NS_ERROR_ILLEGAL_VALUE null pointer passed in
NS_ERROR_UNEXPECTED internal error (possible memory corruption)

The documentation for this interface was generated from the following file: