CreateEvent是一个Windows API函式。它用来创建或打开一个命名的或无名的事件对象。如果想为对象指定一个访问掩码,应当使用CreateEventEx函式。
基本介绍
- 外文名CreateEvent
- 属于Windows API函式
- 作用创建或打开一个命名的事件对象
- 运行环境Windows
语法
HANDLECreateEvent(
LPSECURITY_ATTRIBUTESlpEventAttributes,// 安全属性
BOOLbManualReset,// 复位方式
BOOLbInitialState,// 初始状态
LPCTSTRlpName // 对象名称
);
参数
lpEventAttributes[输入]
一个指向SECURITY_ATTRIBUTES结构的指针,确定返回的句柄是否可被子进程继承。如果lpEventAttributes是NULL,此句柄不能被继承。
Windows NT/2000lpEventAttributes的结构中的成员为新的事件指定了一个安全符。如果lpEventAttributes是NULL,事件将获得一个默认的安全符。
bManualReset[输入]
指定将事件对象创建成手动复原还是自动复原。如果是TRUE,那幺必须用ResetEvent函式来手工将事件的状态复原到无信号状态。如果设定为FALSE,当一个等待执行绪被释放以后,系统将会自动将事件状态复原为无信号状态。
bInitialState[输入]
指定事件对象的初始状态。如果为TRUE,初始状态为有信号状态;否则为无信号状态。
lpName[输入]
指定事件的对象的名称,是一个以0结束的字元串指针。名称的字元格式限定在MAX_PATH之内。名字是对大小写敏感的。
如果lpName指定的名字,与一个存在的命名的事件对象的名称相同,函式将请求EVENT_ALL_ACCESS来访问存在的对象。这时候,由于bManualReset和bInitialState参数已经在创建事件的进程中设定,这两个参数将被忽略。如果lpEventAttributes是参数不是NULL,它将确定此句柄是否可以被继承,其安全描述符成员将被忽略。
如果lpName为NULL,将创建一个无名的事件对象。
如果lpName的和一个存在的信号、互斥、等待计时器、作业或者是档案映射对象名称相同,函式将会失败,在GetLastError函式中将返回ERROR_INVALID_HANDLE。造成这种现象的原因是这些对象共享同一个命名空间。
终端服务(Terminal Services)名称中可以加入"Global\"或是"Local\"的前缀,这样可以明确的将对象创建在全局的或事务的命名空间。名称的其它部分除了反斜槓(\),可以使用任意字元。详细内容可参考Kernel Object Name Spaces。
Windows 2000在Windows 2000系统中,没有终端服务运行,"Global\"和"Local\"前缀将被忽略。名称的其它部分除了反斜槓(\),可以使用任意字元。
Windows NT 4.0以及早期版本,Windows 95/98名称中除了反斜槓(\),可以使用任意字元。
返回值
如果函式调用成功,函式返回事件对象的句柄。如果对于命名的对象,在函式调用前已经被创建,函式将返回存在的事件对象的句柄,而且在GetLastError函式中返回ERROR_ALREADY_EXISTS。
如果函式失败,函式返回值为NULL,如果需要获得详细的错误信息,需要调用GetLastError。
备注
调用CreateEvent函式返回的句柄,该句柄具有EVENT_ALL_ACCESS许可权去访问新的事件对象,它可以在任何有此事件对象句柄的函式中使用。
在调用的过程中,所有执行绪都可以在一个等待函式中指定事件对象句柄。当指定的对象的状态被置为有信号状态时,单对象等待函式将返回。
对于多对象等待函式,可以指定为任意或所有指定的对象被置为有信号状态。当等待函式返回时,等待执行绪将被释放去继续运行。
初始状态在bInitialState参数中进行设定。使用SetEvent函式将事件对象的状态置为有信号状态。使用ResetEvent函式将事件对象的状态置为无信号状态。
当一个手动复原的事件对象的状态被置为有信号状态时,该对象状态将一直保持有信号状态,直至明确调用ResetEvent函式将其置为无符号状态。
当事件的对象被置为有信号状态时,任意数量的等待中执行绪,以及随后开始等待的执行绪均会被释放。
当一个自动复原的事件对象的状态被置为有信号状态时,该对象状态将一直保持有信号状态,直至一个等待执行绪被释放;系统将自动将此函式置为无符号状态。如果没有等待执行绪正在等待,事件对象的状态将保持有信号状态。
多个进程可持有同一个事件对象的多个句柄,可以通过使用此对象来实现进程间的同步。下面的对象共享机制是可行的
- 在CreateEvent函式中,lpEventAttributes参数指定句柄可被继承时,通过CreateProcess函式创建的子进程继承的事件对象句柄。
- 一个进程可以在DuplicateHandle函式中指定事件对象句柄,从而获得一个複製的句柄,此句柄可以被其它进程使用。
- 一个进程可以在OpenEvent或CreateEvent函式中指定一个名字,从而获得一个有名的事件对象句柄。
使用CloseHandle函式关闭句柄。当进程停止时,系统将自动关闭句柄。当一个句柄被关闭后,事件对象将被销毁。
示例
// CreatEventDemo.cpp : Defines the entry point for the console application.
//
#include "stdafx.h"
#include "iostream"
#include "windows.h"
using namespace std;
DWORD WINAPI ThreadProc1(LPVOID lpParam);
DWORD WINAPI ThreadProc2(LPVOID lpParam);
HANDLE hEvent = NULL;
HANDLE hThread1 = NULL;
HANDLE hThread2 = NULL;
int main(int argc,char args[])
{
hEvent = CreateEvent(NULL,TRUE,TRUE,NULL); //使用手动重置为无信号状态,初始化时有信号状态
hThread1 = CreateThread(NULL,0,(LPTHREAD_START_ROUTINE)ThreadProc1,NULL,0,NULL);
Sleep(200);
hThread2 = CreateThread(NULL,0,(LPTHREAD_START_ROUTINE)ThreadProc2,NULL,0,NULL);
Sleep(200);
if (NULL == hThread1 || NULL == hThread2)
{
cout <<"create thread fail!";
}
//DWORD dCount = ResumeThread(hThread);
return 0;
}
DWORD WINAPI ThreadProc1(LPVOID lpParam)
{
cout <<"in thread1@!"<<endl;
DWORD dReturn = WaitForSingleObject(hEvent,INFINITE);
if (WAIT_OBJECT_0 == dReturn)
{
cout <<" thread1 signaled ! "<<endl;
}
cout <<"in thread1 --signal"<<endl;
//SetEvent(hEvent);
return 0;
}
DWORD WINAPI ThreadProc2(LPVOID lpParam)
{
cout <<"in thread2@!"<<endl;
DWORD dReturn = WaitForSingleObject(hEvent,INFINITE);
if (WAIT_OBJECT_0 == dReturn)
{
cout <<"thread2 signaled ! "<<endl;
}
cout <<"in thread2--signal"<<endl;
return 0;
}
使用环境
客户端 | 需要Windows XP、Windows 2000 Professional、Windows NT Workstation、Windows Me、Windows 98或者Windows 95。 |
---|---|
伺服器 | 需要Windows Server 2003、Windows 2000 Server或Windows NT Server。 |
头档案 | 在Winbase.h中声明,包含于Windows.h。 |
库档案 | Kernel32.lib |
DLL | 需要Kernel32.dll。 |
Unicode | 以CreateEventW(Unicode) 和CreateEventA(ANSI)的形式实现。 |
一个Event被创建以后,可以用OpenEvent()API来获得它的Handle,用CloseHandle()来关闭它,用SetEvent()或PulseEvent()来设定它使其有信号,用ResetEvent()来使其无信号,用WaitForSingleObject()或WaitForMultipleObjects()来等待其变为有信号.
PulseEvent()是一个比较有意思的使用方法,正如这个API的名字,它使一个Event对象的状态发生一次脉冲变化,从无信号变成有信号再变成无信号,而整个操作是原子的.对自动复位的Event对象,它仅释放第一个等到该事件的thread(如果有),而对于人工复位的Event对象,它释放所有等待的thread.