You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.

Skip to main content

TOC PREV NEXT INDEX

Embedding Gecko API

nsIWeakReference

This interface gives access to 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 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. This interface is scriptable.

See also: nsISupportsWeakReference

Methods
QueryReferent

Queries the referent, if it exists, and like QueryInterface, returns 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.

Syntax: 

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

Parameters:

uuid: The IID of the interface being requested.
result: [out] The interface pointer to be filled in if the interface is accessible.

nsresult:

NS_OK if successful.
Written by:Ellen Evans | Comments, questions, complaints? Bug 143387
TOC PREV NEXT INDEX