EnhEvent.Flatten

[This is preliminary documentation and subject to change.]

The Flatten method converts an event into its low-level component events. This method can cause the stream compiler to add new events and change event times slightly.

Syntax

object.Flatten()

Parts

object: Object expression that resolves to an EnhEvent object.

Remarks

You can only call EnhEvent.Flatten for events that are part of an enhancement stream. Calling EnhEvent.Flatten for events that have not been added to an enhancement stream causes the method to return an error.

You can use EnhEvent.Flatten to flatten a single event. This differs from EnhEvents.Flatten, which flattens the entire stream.

The event-level Flatten converts a single event to low-level format in exactly the same way as the stream-level Flatten converts the stream — dependencies and repetitions are resolved into individual events.

EnhEvent.Flatten does not affect microevents within an event. For example, if an event contained a file download and a user-defined comment, the microevents would not be expanded into two separate events.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in stream.idl.
  Import Library: Included as a resource in stream.dll.
  Unicode: Yes.

Examples

The following example converts a high-level event into low-level format.