Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIWeakReference Interface Reference

An instance of |nsIWeakReference| is a proxy object that cooperates with its referent to give clients a non-owning, non-dangling reference. More...

import "nsIWeakReference.idl";

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

List of all members.

Public Member Functions

void QueryReferent (in nsIIDRef uuid,[iid_is(uuid), retval] out nsQIResult result)
 |QueryReferent| queries the referent, if it exists, and like |QueryInterface|, produces an owning reference to the desired interface.

Detailed Description

An instance of |nsIWeakReference| is a proxy object that cooperates with its referent to give clients a non-owning, non-dangling reference.

Clients own the proxy, and should generally manage it with an |nsCOMPtr| (see the type |nsWeakPtr| for a |typedef| name that stands out) as they would any other XPCOM object. The |QueryReferent| member function provides a (hopefully short-lived) owning reference on demand, through which clients can get useful access to the referent, while it still exists.

FROZEN

Version:
1.0
See also:
nsISupportsWeakReference
nsWeakReference
nsWeakPtr

Definition at line 59 of file nsIWeakReference.idl.


Member Function Documentation

void nsIWeakReference::QueryReferent ( in nsIIDRef  uuid,
[iid_is(uuid), retval] out nsQIResult  result 
)

|QueryReferent| queries the referent, if it exists, and like |QueryInterface|, produces an owning reference to the desired interface.

It is designed to look and act exactly like (a proxied) |QueryInterface|. Don't hold on to the produced interface permanently; that would defeat the purpose of using a non-owning |nsIWeakReference| in the first place.

Here is the caller graph for this function:


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