npruntime.h File Reference

NP_BEGIN_MACRO

NP_END_MACRO

Typedef NPObject

typedef struct NPObject

NPObject

Typedef NPClass

typedef struct NPClass

NPClass

Typedef NPUTF8

typedef char

NPUTF8

Typedef NPString

typedef struct _NPString

NPString

Enum NPVariantType

Enumerator	Value	Description
NPVariantType_Void
NPVariantType_Null
NPVariantType_Bool
NPVariantType_Int32
NPVariantType_Double
NPVariantType_String
NPVariantType_Object

Typedef NPVariant

typedef struct _NPVariant

NPVariant

NPN_ReleaseVariantValue ( NPVariant * )

void

NPN_ReleaseVariantValue

(

NPVariant *

variant

)

NPN_ReleaseVariantValue() releases the value in the given variant

This must always be called on result variants and such in this API, i.e. any NPVariant whose value comes from a call that passes back an NPVariant must be released using this function. Access to the value in an NPVariant that has been released will result in undefined behavior

Parameters
variant	The variant whose value is to be released

NPVARIANT_IS_VOID

NPVARIANT_IS_NULL

NPVARIANT_IS_BOOLEAN

NPVARIANT_IS_INT32

NPVARIANT_IS_DOUBLE

NPVARIANT_IS_STRING

NPVARIANT_IS_OBJECT

NPVARIANT_TO_BOOLEAN

NPVARIANT_TO_INT32

NPVARIANT_TO_DOUBLE

NPVARIANT_TO_STRING

NPVARIANT_TO_OBJECT

VOID_TO_NPVARIANT

NULL_TO_NPVARIANT

BOOLEAN_TO_NPVARIANT

INT32_TO_NPVARIANT

DOUBLE_TO_NPVARIANT

STRINGZ_TO_NPVARIANT

STRINGN_TO_NPVARIANT

OBJECT_TO_NPVARIANT

Typedef NPIdentifier

typedef void *

NPIdentifier

NPN_GetStringIdentifier ( const NPUTF8 * )

NPIdentifier

NPN_GetStringIdentifier

(

const NPUTF8 *

name

)

Returns an opaque identifier for the string that is passed in.

Parameters
name	The string for which an opaque identifier should be returned

Return Value: An NPIdentifier identifying the string

NPN_GetStringIdentifiers ( const NPUTF8 **, int32_t, NPIdentifier * )

void	NPN_GetStringIdentifiers	(	const NPUTF8 **	names,
			int32_t	nameCount,
			NPIdentifier *	identifiers
		)

NPN_GetIntIdentifier ( int32_t )

NPIdentifier

NPN_GetIntIdentifier

(

int32_t

intid

)

Returns an opaque identifier for the integer that is passed in.

Parameters
intid	The integer for which an opaque identifier should be returned

Return Value: An NPIdentifier identifying the integer

NPN_IdentifierIsString ( NPIdentifier )

bool

NPN_IdentifierIsString

(

NPIdentifier

identifier

)

Determines whether or not an identifier is a string.

Parameters
identifier	The identifier whose type is to be examined

Return Value: true if the identifier is a string identifier, or false otherwise

NPN_UTF8FromIdentifier ( NPIdentifier )

NPUTF8 *

NPN_UTF8FromIdentifier

(

NPIdentifier

identifier

)

Returns the UTF-8 string corresponding to the given string identifier.

Parameters
identifier	The string identifier whose corresponding string should be returned

Return Value: A UTF-8 string as a sequence of NPUTF8 bytes, or NULL if the specified identifier isn't a string identifier.

NPN_IntFromIdentifier ( NPIdentifier )

int32_t

NPN_IntFromIdentifier

(

NPIdentifier

identifier

)

Returns the integer value corresponding to the given integer identifier.

Parameters
identifier	The integer identifier whose corresponding integer value should be returned

Return Value: An integer corresponding to the specified identifier

Typedef NPAllocateFunctionPtr

typedef NPObject *(*

NPAllocateFunctionPtr

Typedef NPDeallocateFunctionPtr

typedef void(*

NPDeallocateFunctionPtr

Typedef NPInvalidateFunctionPtr

typedef void(*

NPInvalidateFunctionPtr

Typedef NPHasMethodFunctionPtr

typedef bool(*

NPHasMethodFunctionPtr

Typedef NPInvokeFunctionPtr

typedef bool(*

NPInvokeFunctionPtr

Typedef NPInvokeDefaultFunctionPtr

typedef bool(*

NPInvokeDefaultFunctionPtr

Typedef NPHasPropertyFunctionPtr

typedef bool(*

NPHasPropertyFunctionPtr

Typedef NPGetPropertyFunctionPtr

typedef bool(*

NPGetPropertyFunctionPtr

Typedef NPSetPropertyFunctionPtr

typedef bool(*

NPSetPropertyFunctionPtr

Typedef NPRemovePropertyFunctionPtr

typedef bool(*

NPRemovePropertyFunctionPtr

Typedef NPEnumerationFunctionPtr

typedef bool(*

NPEnumerationFunctionPtr

Typedef NPConstructFunctionPtr

typedef bool(*

NPConstructFunctionPtr

NP_CLASS_STRUCT_VERSION

NP_CLASS_STRUCT_VERSION_ENUM

NP_CLASS_STRUCT_VERSION_CTOR

NP_CLASS_STRUCT_VERSION_HAS_ENUM

NP_CLASS_STRUCT_VERSION_HAS_CTOR

NPN_CreateObject ( NPP, NPClass * )

NPObject *	NPN_CreateObject	(	NPP	npp,
			NPClass *	aClass
		)

Allocates a new NPObject.

Parameters
npp	The NPP indicating which plugin wants to instantiate the object
aClass	The class to instantiate an object of.

Return Value: The newly-allocated NPObject

NPN_RetainObject ( NPObject * )

NPObject *

NPN_RetainObject

(

NPObject *

npobj

)

Increments the reference count of the given NPObject.

Parameters
npobj	The NPObject to retain

Return Value: A pointer back to the same object.

NPN_ReleaseObject ( NPObject * )

void

NPN_ReleaseObject

(

NPObject *

npobj

)

Decrements the reference count of the given NPObject. If the reference count reaches 0, the NPObject is deallocated by calling its deallocate function if one is provided; if one is not provided, free() is used.

Parameters
npobj	The NPObject whose reference count should be decremented

NPN_Invoke ( NPP, NPObject , NPIdentifier, const NPVariant , uint32_t, NPVariant * )

bool	NPN_Invoke	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	methodName,
			const NPVariant *	args,
			uint32_t	argCount,
			NPVariant *	result
		)

Invokes a method on the given NPObject.

Parameters
npp	The NPP indicating which plugin wants to call the method on the object
npobj	The object on which to invoke a method
methodName	A string identifier indicating the name of the name of the method to invoke
args	An array of arguments to pass to the method
argCount	The number of arguments in the args array
result	A pointer to an NPVariant to receive the result returned by the method When the caller no longer needs the result, it must call NPN_ReleaseVariantValue() to release it.

Return Value: true if the method was successfully invoked, otherwise false. If the method was invoked successfully, any return value is stored in the NPVariant specified by result

NPN_InvokeDefault ( NPP, NPObject , const NPVariant , uint32_t, NPVariant * )

bool	NPN_InvokeDefault	(	NPP	npp,
			NPObject *	npobj,
			const NPVariant *	args,
			uint32_t	argCount,
			NPVariant *	result
		)

Invokes the default method, if one exists, on the given NPObject

Parameters
npp	The NPP indicating which plugin wants to call the method on the object
npobj	The object on which to invoke the default method
args	An array of arguments to pass to the method
argCount	The number of arguments in the args array
result	A pointer to an NPVariant to receive the result returned by the method When the caller no longer needs the result, it must call NPN_ReleaseVariantValue() to release it.

Return Value: true if the method was successfully invoked, otherwise false. If the method was invoked successfully, any return value is stored in the NPVariant specified by result

NPN_Evaluate ( NPP, NPObject , NPString , NPVariant * )

bool	NPN_Evaluate	(	NPP	npp,
			NPObject *	npobj,
			NPString *	script,
			NPVariant *	result
		)

Invokes a method on the given NPObject.

Parameters
npp	The NPP indicating which plugin instance's window to evaluate the script in.
npobj	The object on which to evaluate the script
script	The script to evaluate
result	On return, contains the value returned by the script The caller must call NPN_ReleaseVariantValue() to release the returned value when it's no longer needed

Return Value: true if the script was evaluated successfully, otherwise false

NPN_GetProperty ( NPP, NPObject , NPIdentifier, NPVariant )

bool	NPN_GetProperty	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	propertyName,
			NPVariant *	result
		)

Gets the value of a property on the specified NPObject.

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object from which a value is to be retrieved.
propertyName	A string identifier indicating the name of the property whose value is to be retrieved
result	On return, contains the value of the specified property The caller must call NPN_ReleaseVariantValue() to release the returned value when it's no longer needed

Return Value: true if the script was evaluated successfully, otherwise false

NPN_SetProperty ( NPP, NPObject , NPIdentifier, const NPVariant )

bool	NPN_SetProperty	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	propertyName,
			const NPVariant *	value
		)

Sets the value of a property on the specified NPObject.

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object on which a value is to be set.
propertyName	A string identifier indicating the name of the property whose value is to be retrieved
value	The value to store in the specified property

Return Value: true if the value was set successfully, otherwise false

NPN_RemoveProperty ( NPP, NPObject *, NPIdentifier )

bool	NPN_RemoveProperty	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	propertyName
		)

Removes a property from the specified NPObject

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object on which a property is to be deleted
propertyName	A string identifier indicating the name of the property to remove

Return Value: true if the property was removed successfully, otherwise false

NPN_HasProperty ( NPP, NPObject *, NPIdentifier )

bool	NPN_HasProperty	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	propertyName
		)

Determines whether or not the specified NPObject has a particular property

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object on which to look for the property
propertyName	A string identifier indicating the name of the property to look for

Return Value: true if the property exists on the specified object, otherwise false

NPN_HasMethod ( NPP, NPObject *, NPIdentifier )

bool	NPN_HasMethod	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier	methodName
		)

Determines whether or not the specified NPObject has a particular method

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object on which to look for the method
methodName	A string identifier indicating the name of the method to look for

Return Value: true if the method exists on the specified object, otherwise false.

NPN_Enumerate ( NPP, NPObject *, NPIdentifier **, uint32_t * )

bool	NPN_Enumerate	(	NPP	npp,
			NPObject *	npobj,
			NPIdentifier **	identifier,
			uint32_t *	count
		)

List all of identifiers in a NPObject

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	The object on which to look for the indeifiers
identifier	array of identifiers returned

Return Value: true if the method succeeded, otherwise false.

NPN_Construct ( NPP, NPObject , const NPVariant , uint32_t, NPVariant * )

bool	NPN_Construct	(	NPP	npp,
			NPObject *	npobj,
			const NPVariant *	args,
			uint32_t	argCount,
			NPVariant *	result
		)

Create a NPObject

Parameters
npp	The NPP indicating which plugin instance's is making the request
npobj	an input NPObject
args	An array of arguments to pass to the method
argCount	number of arguments
result	new created NPObject

Return Value: true if the method succeeded, otherwise false.

_NPN_SetException ( NPObject , const NPUTF8 )

void	_NPN_SetException	(	NPObject *	npobj,
			const NPUTF8 *	message
		)

npruntime.h File Reference

NP_BEGIN_MACRO

NP_END_MACRO

Typedef NPObject

Typedef NPClass

Typedef NPUTF8

Typedef NPString

Enum NPVariantType

Typedef NPVariant

NPN_ReleaseVariantValue ( NPVariant * )

NPVARIANT_IS_VOID

NPVARIANT_IS_NULL

NPVARIANT_IS_BOOLEAN

NPVARIANT_IS_INT32

NPVARIANT_IS_DOUBLE

NPVARIANT_IS_STRING

NPVARIANT_IS_OBJECT

NPVARIANT_TO_BOOLEAN

NPVARIANT_TO_INT32

NPVARIANT_TO_DOUBLE

NPVARIANT_TO_STRING

NPVARIANT_TO_OBJECT

VOID_TO_NPVARIANT

NULL_TO_NPVARIANT

BOOLEAN_TO_NPVARIANT

INT32_TO_NPVARIANT

DOUBLE_TO_NPVARIANT

STRINGZ_TO_NPVARIANT

STRINGN_TO_NPVARIANT

OBJECT_TO_NPVARIANT

Typedef NPIdentifier

NPN_GetStringIdentifier ( const NPUTF8 * )

NPN_GetStringIdentifiers ( const NPUTF8 **, int32_t, NPIdentifier * )

NPN_GetIntIdentifier ( int32_t )

NPN_IdentifierIsString ( NPIdentifier )

NPN_UTF8FromIdentifier ( NPIdentifier )

NPN_IntFromIdentifier ( NPIdentifier )

Typedef NPAllocateFunctionPtr

Typedef NPDeallocateFunctionPtr

Typedef NPInvalidateFunctionPtr

Typedef NPHasMethodFunctionPtr

Typedef NPInvokeFunctionPtr

Typedef NPInvokeDefaultFunctionPtr

Typedef NPHasPropertyFunctionPtr

Typedef NPGetPropertyFunctionPtr

Typedef NPSetPropertyFunctionPtr

Typedef NPRemovePropertyFunctionPtr

Typedef NPEnumerationFunctionPtr

Typedef NPConstructFunctionPtr

NP_CLASS_STRUCT_VERSION

NP_CLASS_STRUCT_VERSION_ENUM

NP_CLASS_STRUCT_VERSION_CTOR

NP_CLASS_STRUCT_VERSION_HAS_ENUM

NP_CLASS_STRUCT_VERSION_HAS_CTOR

NPN_CreateObject ( NPP, NPClass * )

NPN_RetainObject ( NPObject * )

NPN_ReleaseObject ( NPObject * )

NPN_Invoke ( NPP, NPObject *, NPIdentifier, const NPVariant *, uint32_t, NPVariant * )

NPN_InvokeDefault ( NPP, NPObject *, const NPVariant *, uint32_t, NPVariant * )

NPN_Evaluate ( NPP, NPObject *, NPString *, NPVariant * )

NPN_GetProperty ( NPP, NPObject *, NPIdentifier, NPVariant * )

NPN_SetProperty ( NPP, NPObject *, NPIdentifier, const NPVariant * )

NPN_RemoveProperty ( NPP, NPObject *, NPIdentifier )

NPN_HasProperty ( NPP, NPObject *, NPIdentifier )

NPN_HasMethod ( NPP, NPObject *, NPIdentifier )

NPN_Enumerate ( NPP, NPObject *, NPIdentifier **, uint32_t * )

NPN_Construct ( NPP, NPObject *, const NPVariant *, uint32_t, NPVariant * )

_NPN_SetException ( NPObject *, const NPUTF8 * )

NPN_Invoke ( NPP, NPObject , NPIdentifier, const NPVariant , uint32_t, NPVariant * )

NPN_InvokeDefault ( NPP, NPObject , const NPVariant , uint32_t, NPVariant * )

NPN_Evaluate ( NPP, NPObject , NPString , NPVariant * )

NPN_GetProperty ( NPP, NPObject , NPIdentifier, NPVariant )

NPN_SetProperty ( NPP, NPObject , NPIdentifier, const NPVariant )

NPN_Construct ( NPP, NPObject , const NPVariant , uint32_t, NPVariant * )

_NPN_SetException ( NPObject , const NPUTF8 )