newObjects ActiveX Pack1 Event

See also object creation information - ClassID/ProgID 

Overview | Reference


Event object.  


method.gif (107 bytes) Create Syntax:
object.Create([manual [, initstate [, name]]])

Initializes the object. Must be called before usage.

manual - Boolean, default is False. If True the Event will not reset automatically after successful wait/IsSet operation.

initstate - Boolean indicating the initial state of the Event. Default is False

name - name of the Event, default is unnamed (empty string does the same).

method.gif (107 bytes) Reset Syntax:

Resets the Event object. Especially needed if the object is configured for manual reset.

method.gif (107 bytes) Pulse Syntax:

Sets the event for an instant so a waiting thread can proceed. Can be useful for manual reset events.

method.gif (107 bytes) Set Syntax:

Sets the Event. A waiting operation will succeed after that.

method.gif (107 bytes) Wait Syntax:
b = object.Wait([timeout])

Waits the specified time for the event to become set.

Returns: True if the wait operation is successful and False if the Timeout has been exceeded.

timeout - (long) milliseconds to wait. Default is infinite (-1).

method.gif (107 bytes) CheckAndReset Syntax:
b = object.CheckAndReset

Like Wait but this will just check the event state, return it as Boolean result and reset the event no matter what is its mode (manual or automatic).

Valid Syntax:
b = object.Valid

Checks if the object is valid - initialized. If the Create method has not been called yet it will return False, otherwise True will be returned. Rarely needed but in applications with code spread through many files (such as ASP applications) it may be useful to resolve some application design problems.

IsSet Syntax:
b = object.IsSet

Like Wait but waits 0 milliseconds and returns the state of the Event object (Boolean). Especially useful for manual reset events.


newObjects Copyright 2001-2006 newObjects [ ]