xevent Class Reference

BASE CLASS FOR EVENTS. More...

#include <Zclassut.h>

List of all members.

Public Member Functions
void	Create (LPCTSTR lpName=__nil)
void	Open (LPCTSTR lpName=__nil)
Public Attributes
bool	verbose
unsigned long	error_code

---

Detailed Description

BASE CLASS FOR EVENTS.

Provides methods for manipulating events objects. An event object is a synchronization object whose state can be explicitly set to signaled. The event object is useful in sending a signal to a thread indicating that a particular event has occurred. For example,in overlapped input and output,the system sets a specified event object to the signaled state when the overlapped operation has been completed.

---

Member Function Documentation

void xevent::Create

(

LPCTSTR

lpName = __nil

)

Creates a named or unnamed event object.

Parameters:

lpName

- Pointer to a null-terminated string specifying the name of the event object. The name is limited to MAX_PATH characters and can contain any character except the backslash path-separator character (\). Name comparison is case sensitive. If lpName matches the name of an existing named event object,this function requests EVENT_ALL_ACCESS access to the existing object. In this case,the bManualReset and bInitialState parameters are ignored because they have already been set by the creating process. If the lpEventAttributes parameter is not NULL,it determines whether the handle can be inherited,but its security-descriptor member is ignored. If lpName is NULL,the event object is created without a name. If lpName matches the name of an existing semaphore,mutex,waitable timer,job,or file-mapping object,the function fails.

void xevent::Open

(

LPCTSTR

lpName = __nil

)

Opens a named event object.

Parameters:

lpName

- Pointer to a null-terminated string specifying the name of the event object. The name is limited to MAX_PATH characters and can contain any character except the backslash path-separator character (\). Name comparison is case sensitive.

---

Member Data Documentation

unsigned long xevent::error_code

A per-thread value set by Win32 functions when an error occurs.

bool xevent::verbose

In case of errors, the function members will show a message box with detailed information. This member may be one of following values:

• __talk - show details.
• __silent - don't show details.

---

The documentation for this class was generated from the following file:

• ZKERNEL/Zclassut.h