Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsILDAPMessage Interface Reference

import "nsILDAPMessage.idl";

Inheritance diagram for nsILDAPMessage:
Inheritance graph
[legend]
Collaboration diagram for nsILDAPMessage:
Collaboration graph
[legend]

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.

Detailed Description

Definition at line 46 of file nsILDAPMessage.idl.


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_VALUEnull pointer passed in
NS_ERROR_UNEXPECTEDbug or memory corruption
NS_ERROR_LDAP_DECODING_ERRORproblem 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:
attrThe attribute whose values are to be returned
countNumber of values in the outbound array.
valuesArray of nsILDAPBERValue objects
Exceptions:
NS_ERROR_UNEXPECTEDBug or memory corruption
NS_ERROR_LDAP_DECODING_ERRORAttribute 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:
attrThe attribute whose values are to be returned
countNumber of values in the outbound array.
valuesArray of values
Exceptions:
NS_ERROR_UNEXPECTEDBug or memory corruption
NS_ERROR_LDAP_DECODING_ERRORAttribute not found or other decoding error.
NS_ERROR_OUT_OF_MEMORY

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_MEMORYran out of memory
NS_ERROR_ILLEGAL_VALUEnull pointer passed in
NS_ERROR_LDAP_DECODING_ERRORproblem during BER-decoding
NS_ERROR_UNEXPECTEDbug or memory corruption

Definition at line 56 of file nsILDAPMessage.idl.

The result code (aka lderrno) for this message.

IDL definitions for these constants live in nsILDAPErrors.idl.

Exceptions:
NS_ERROR_ILLEGAL_VALUEnull pointer passed in

Definition at line 100 of file nsILDAPMessage.idl.

Additional error information optionally sent by the server.

Definition at line 175 of file nsILDAPMessage.idl.

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.

Definition at line 182 of file nsILDAPMessage.idl.

The operation this message originated from.

Exceptions:
NS_ERROR_NULL_POINTERNULL pointer to getter

Definition at line 91 of file nsILDAPMessage.idl.

The result of an add operation.

Definition at line 143 of file nsILDAPMessage.idl.

Result of a bind operation.

Definition at line 117 of file nsILDAPMessage.idl.

The result of a compare operation.

Definition at line 158 of file nsILDAPMessage.idl.

The result of a delete operation.

Definition at line 148 of file nsILDAPMessage.idl.

The result of an LDAPv3 extended operation.

Definition at line 163 of file nsILDAPMessage.idl.

The result of an modify DN operation.

Definition at line 153 of file nsILDAPMessage.idl.

The result of a modify operation.

Definition at line 138 of file nsILDAPMessage.idl.

An entry found in an search operation.

Definition at line 122 of file nsILDAPMessage.idl.

An LDAPv3 search reference (a referral to another server)

Definition at line 127 of file nsILDAPMessage.idl.

The result of a search operation (i.e.

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

Definition at line 133 of file nsILDAPMessage.idl.

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_VALUEnull pointer passed in
NS_ERROR_UNEXPECTEDinternal error (possible memory corruption)

Definition at line 112 of file nsILDAPMessage.idl.


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