IWebScriptObject Interface Reference

import"IWebScriptObject.idl";

Inheritance diagram for IWebScriptObject:

Public Member Functions
HRESULT	throwException ([in] BSTR exceptionMessage, [out, retval] BOOL *result)
HRESULT	callWebScriptMethod ([in] BSTR name, [in, size_is(cArgs)] const VARIANT args[], [in] int cArgs, [out, retval] VARIANT *result)
HRESULT	evaluateWebScript ([in] BSTR script, [out, retval] VARIANT *result)
HRESULT	removeWebScriptKey ([in] BSTR name)
HRESULT	stringRepresentation ([out, retval] BSTR *stringRepresentation)
HRESULT	webScriptValueAtIndex ([in] unsigned int index, [out, retval] VARIANT *result)
HRESULT	setWebScriptValueAtIndex ([in] unsigned int index, [in] VARIANT val)
HRESULT	setException ([in] BSTR description)

Member Function Documentation

callWebScriptMethod()

HRESULT IWebScriptObject::callWebScriptMethod	(	[in] BSTR	name,
		[in, size_is(cArgs)] const VARIANT	args[],
		[in] int	cArgs,
		[out, retval] VARIANT *	result
	)

callWebScriptMethod:withArguments:

Parameters

name	The name of the method to call in the script environment.
args	The arguments to pass to the script environment. Calls the specified method in the script environment using the specified arguments.

Returns

Returns the result of calling the script method.

• (id)callWebScriptMethod:(NSString *)name withArguments:(NSArray *)args;

evaluateWebScript()

HRESULT IWebScriptObject::evaluateWebScript	(	[in] BSTR	script,
		[out, retval] VARIANT *	result
	)

evaluateWebScript:

Parameters

script

The script to execute in the target script environment. The script will be executed in the target script environment. The format of the script is dependent of the target script environment.

Returns

Returns the result of evaluating the script in the script environment.

• (id)evaluateWebScript:(NSString *)script;

removeWebScriptKey()

HRESULT IWebScriptObject::removeWebScriptKey

(

[in] BSTR

name

)

removeWebScriptKey:

Parameters

name	The name of the property to remove. Removes the property from the object in the script environment. (void)removeWebScriptKey:(NSString *)name;

setException()

HRESULT IWebScriptObject::setException

(

[in] BSTR

description

)

setException:

Parameters

description

The description of the exception. Raises an exception in the script environment in the context of the current object. (void)setException: (NSString *)description;

setWebScriptValueAtIndex()

HRESULT IWebScriptObject::setWebScriptValueAtIndex	(	[in] unsigned int	index,
		[in] VARIANT	val
	)

setPropertyAtIndex:value:

Parameters

index	The index of the property to set.
value	The value of the property to set. Sets the property value at the specified index. (void)setWebScriptValueAtIndex:(unsigned int)index value:(id)value;

stringRepresentation()

HRESULT IWebScriptObject::stringRepresentation

(

[out, retval] BSTR *

stringRepresentation

)

toString Converts the target object to a string representation. The coercion of non string objects type is dependent on the script environment.

Returns

Returns the string representation of the object.

• (NSString *)stringRepresentation;

throwException()

HRESULT IWebScriptObject::throwException	(	[in] BSTR	exceptionMessage,
		[out, retval] BOOL *	result
	)

throwException: Throws an exception in the current script execution context.

Returns

Either NO if an exception could not be raised, YES otherwise.

• (BOOL)throwException:(NSString *)exceptionMessage;

webScriptValueAtIndex()

HRESULT IWebScriptObject::webScriptValueAtIndex	(	[in] unsigned int	index,
		[out, retval] VARIANT *	result
	)

propertyAtIndex:

Parameters

index

The index of the property to return. Index based access is dependent Gets the value of the property at the specified index.

Returns

The value of the property.

• (id)webScriptValueAtIndex:(unsigned int)index;

---

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

• Source/WebKit/win/Interfaces/IWebScriptObject.idl