Public Types | Public Member Functions

nsAXPCNativeCallContext Class Reference

A native call context is allocated on the stack when XPConnect calls a native method. More...

#include <nsAXPCNativeCallContext.h>

List of all members.

Public Types

enum  { LANG_UNKNOWN = 0, LANG_JS = 1, LANG_NATIVE = 2 }

Public Member Functions

NS_IMETHOD GetCallee (nsISupports **aResult)=0
NS_IMETHOD GetCalleeMethodIndex (PRUint16 *aResult)=0
NS_IMETHOD GetCalleeWrapper (nsIXPConnectWrappedNative **aResult)=0
NS_IMETHOD GetJSContext (JSContext **aResult)=0
NS_IMETHOD GetArgc (PRUint32 *aResult)=0
NS_IMETHOD GetArgvPtr (jsval **aResult)=0
NS_IMETHOD GetRetValPtr (jsval **aResult)=0
 This may be NULL if the JS caller is ignoring the result of the call.
NS_IMETHOD GetReturnValueWasSet (PRBool *aResult)=0
 Set this to indicate that the callee has directly set the return value (using RetValPtr and the JSAPI).
NS_IMETHOD SetReturnValueWasSet (PRBool aValue)=0
NS_IMETHOD GetCalleeInterface (nsIInterfaceInfo **aResult)=0
NS_IMETHOD GetCalleeClassInfo (nsIClassInfo **aResult)=0
NS_IMETHOD GetPreviousCallContext (nsAXPCNativeCallContext **aResult)=0
NS_IMETHOD GetLanguage (PRUint16 *aResult)=0

Detailed Description

A native call context is allocated on the stack when XPConnect calls a native method.

Holding a pointer to this object beyond the currently executing stack frame is not permitted.


Member Enumeration Documentation

anonymous enum
Enumerator:
LANG_UNKNOWN 
LANG_JS 
LANG_NATIVE 

Member Function Documentation

NS_IMETHOD nsAXPCNativeCallContext::GetArgc ( PRUint32 *  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetArgvPtr ( jsval **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetCallee ( nsISupports **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetCalleeClassInfo ( nsIClassInfo **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetCalleeInterface ( nsIInterfaceInfo **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetCalleeMethodIndex ( PRUint16 *  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetCalleeWrapper ( nsIXPConnectWrappedNative **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetJSContext ( JSContext **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetLanguage ( PRUint16 *  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetPreviousCallContext ( nsAXPCNativeCallContext **  aResult  )  [pure virtual]
NS_IMETHOD nsAXPCNativeCallContext::GetReturnValueWasSet ( PRBool aResult  )  [pure virtual]

Set this to indicate that the callee has directly set the return value (using RetValPtr and the JSAPI).

If set then xpconnect will not attempt to overwrite it with the converted retval from the C++ callee.

NS_IMETHOD nsAXPCNativeCallContext::GetRetValPtr ( jsval **  aResult  )  [pure virtual]

This may be NULL if the JS caller is ignoring the result of the call.

NS_IMETHOD nsAXPCNativeCallContext::SetReturnValueWasSet ( PRBool  aValue  )  [pure virtual]

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