Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
initStorageEvent
Collapse the table of content
Expand the table of content

initStorageEvent method

Initializes a new Document Object Model (DOM) storage event that the IDocumentEvent::createEvent method created.

Internet Explorer 9

 

Syntax


HRESULT retVal = object.initStorageEvent(eventType, canBubble, cancelable, keyArg, oldValueArg, newValueArg, urlArg, storageAreaArg);

Parameters

eventType [in]

Type: BSTR

The following value, or a user-defined custom event type:

storage

An HTMLDocumentEvents3::onstorage event.

canBubble [in]

Type: VARIANT_BOOL

VARIANT_TRUE (true)

The event should propagate upward.

VARIANT_FALSE (false)

The event does not propagate upward.

cancelable [in]

Type: VARIANT_BOOL

VARIANT_TRUE (true)

The default action can be canceled.

VARIANT_FALSE (false)

The default action cannot be canceled.

keyArg [in]

Type: BSTR

The storage key. This value is returned in the IDOMStorageEvent::key attribute of the event.

oldValueArg [in]

Type: BSTR

The previous value of the storage key, or NULL. This value is returned in the IDOMStorageEvent::oldValue attribute of the event.

newValueArg [in]

Type: BSTR

The new value of the storage key, or NULL. This value is returned in the IDOMStorageEvent::newValue attribute of the event.

urlArg [in]

Type: BSTR

The address of the document that is processing the event. This value is returned in the IDOMStorageEvent::url attribute of the event.

storageAreaArg [in]

Type: IHTMLStorage

The Storage object that is modified. This value is returned in the IDOMStorageEvent::storageArea attribute of the event.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

  • , Section 4.4.1

 

 

Community Additions

ADD
Show:
© 2015 Microsoft