OLEStorage object

The OLEStorage object acts as a proxy for an open OLE storage.

You can customize your own version of the OLEStorage object by defining a class user object inherited from the built-in OLEStorage object.

For more information about creating a custom OLEStorage object, see Working with User Objects in Users Guide.

For more information about using the OLEStorage object in an application, see Using OLE in an Application in Application Techniques.

Properties

OLEStorage property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DocumentName

String

Specifies the name of the storage currently open. For a root level storage, this is the name of the file containing the storage. For substorages, this is the member name of the substorage.


Events

OLEStorage event

Occurs

Constructor

When the user object is created.

Destructor

When the user object is destroyed.


Functions

OLEStorage function

Datatype returned

Description

ClassName

String

Returns the name assigned to the user object

Clear

Integer

Releases any storage previously opened

Close

Integer

Saves the storage and any controls and streams open on the storage, commits the changes, then releases the storage. (Same as calling Save, then Clear.)

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service

GetParent

PowerObject

Returns a reference to the name of the parent object

MemberDelete

Integer

Deletes the specified member

MemberExists

Integer

Specifies whether the specified member exists

MemberRename

Integer

Renames the specified member

Open

Integer

Opens the storage from a file or opens a substorage within the specified storage object

PostEvent

Boolean

Adds an event to the end of the message queue of the user object

Save

Integer

Saves the storage and any controls open on that storage and commits the changes

SaveAs

Integer

Copies the storage and any controls open on that new storage to a new file or substorage, commits the changes, then releases original storage

TriggerEvent

Integer

Sends an event to the user object and executes the script associated with the event

TypeOf

Object

Returns the type of the user object