OLEStream object

The OLEStream object acts as a proxy for an OLE stream.

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

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

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

Properties

OLEStream property

Datatype

Description

ClassDefinition

PowerObject

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

Name

String

Specifies the member name of the stream within its parent storage.

Storage

OMStorage

(Read-only) Specifies the storage containing the stream. Streams are always opened from within an OLEStorage object.


Events

OLEStream event

Occurs

Constructor in PowerScript Reference

When the user object is created.

Destructor in PowerScript Reference

When the user object is destroyed.


Functions

OLEStream function

Datatype returned

Description

ClassName in PowerScript Reference

String

Returns the name assigned to the user object.

Close in PowerScript Reference

Integer

Releases any stream previously opened.

GetContextService in PowerScript Reference

Integer

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

GetParent in PowerScript Reference

PowerObject

Returns a reference to the name of the parent object.

Length in PowerScript Reference

Integer

Obtains the length of the open stream.

Open in PowerScript Reference

Integer

Opens the specified stream from the storage.

PostEvent in PowerScript Reference

Boolean

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

Read in PowerScript Reference

Integer

Reads from the stream.

Seek in PowerScript Reference

Integer

Moves within the stream.

TriggerEvent in PowerScript Reference

Integer

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

TypeOf in PowerScript Reference

Object

Returns the type of the user object.

Write in PowerScript Reference

Long

Writes to the stream.