Back to index

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

import "nsILDAPConnection.idl";

Inheritance diagram for nsILDAPConnection:
Inheritance graph
Collaboration diagram for nsILDAPConnection:
Collaboration graph

List of all members.

Public Member Functions

void init (in string aHost, in long aPort, in boolean aSSL, in AUTF8String aBindName, in nsILDAPMessageListener aMessageListener, in nsISupports aClosure, in unsigned long aVersion)
 Set up the connection.
long getLdErrno (out AUTF8String matched, out AUTF8String s)
 Get information about the last error that occured on this connection.

Public Attributes

readonly attribute wstring errorString
 the string version of lderrno
readonly attribute AUTF8String bindName
 DN to bind as.
attribute nsISupports closure
 private parameter (anything caller desires)
const unsigned long VERSION2 = 2
const unsigned long VERSION3 = 3

Detailed Description

Definition at line 46 of file nsILDAPConnection.idl.

Member Function Documentation

long nsILDAPConnection::getLdErrno ( out AUTF8String  matched,
out AUTF8String  s 

Get information about the last error that occured on this connection.

matchedif the server is returning LDAP_NO_SUCH_OBJECT, LDAP_ALIAS_PROBLEM, LDAP_INVALID_DN_SYNTAX, or LDAP_ALIAS_DEREF_PROBLEM, this will contain the portion of DN that matches the entry that is closest to the requested entry
sadditional error information from the server
the error code, as defined in nsILDAPErrors.idl
void nsILDAPConnection::init ( in string  aHost,
in long  aPort,
in boolean  aSSL,
in AUTF8String  aBindName,
in nsILDAPMessageListener  aMessageListener,
in nsISupports  aClosure,
in unsigned long  aVersion 

Set up the connection.

Note that init() must be called on a thread that already has an nsIEventQueue.

aHostserver name for ldap_init()
aPortserver port number for ldap_init() -1 == default port (389)
aSSLuse SSL on this connection?
aBindNameDN to bind as
aMessageListenerCallback for DNS resolution completion
aClosureprivate parameter (anything caller desires)
aVersionLDAP version to use (currently VERSION2 or VERSION3)
NS_ERROR_ILLEGAL_VALUEnull pointer or invalid version
NS_ERROR_OUT_OF_MEMORYran out of memory
NS_ERROR_OFFLINEwe are in off-line mode

Member Data Documentation

readonly attribute AUTF8String nsILDAPConnection::bindName

DN to bind as.

use the init() method to set this.


Definition at line 58 of file nsILDAPConnection.idl.

private parameter (anything caller desires)

Definition at line 63 of file nsILDAPConnection.idl.

the string version of lderrno

Definition at line 51 of file nsILDAPConnection.idl.

Definition at line 90 of file nsILDAPConnection.idl.

Definition at line 91 of file nsILDAPConnection.idl.

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