CeRunAppAtEvent

The CeRunAppAtEvent function starts running an application when a given event occurs.

Syntax

BOOL CeRunAppAtEvent(TCHAR *pwszAppName, LONG lWhichEvent);

At a Glance

Header file: Notify.h
Platforms: H/PC
Versions: 1.01 and later

Parameters

pwszAppName
Pointer to a null-terminated string that specifies the name of the application to be started.
lWhichEvent
Event at which the application is to be started. This parameter can be one of the following values:
NOTIFICATION_EVENT_NONE
No events—remove all event registrations for this application.
NOTIFICATION_EVENT_SYNC_END
When data synchronization finishes.
NOTIFICATION_EVENT_DEVICE_CHANGE
When a PC Card device is changed.
NOTIFICATION_EVENT_RS232_DETECTED
When an RS232 connection is made.
NOTIFICATION_EVENT_TIME_CHANGE
When the system time is changed.
NOTIFICATION_EVENT_RESTORE_END
When a full device data restore completes.

Return Values

If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE.

Remarks

The application is started with a system-defined command line. If there was already an instance of the application running, the new instance must send a private message to the existing instance and then shut down. The command line, which corresponds to the registered event, can be one of the following string constants.

Constant Value
APP_RUN_AFTER_SYNC "AppRunAfterSync"
APP_RUN_AT_AC_POWER_ON "AppRunAtAcPowerOn"
APP_RUN_AT_AC_POWER_OFF "AppRunAtAcPowerOff"
APP_RUN_AT_NET_CONNECT "AppRunAtNetConnect"
APP_RUN_AT_NET_DISCONNECT "AppRunAtNetDisconnect"
APP_RUN_AT_DEVICE_CHANGE "AppRunDeviceChange"
APP_RUN_AT_IR_DISCOVERY "AppRunAtIrDiscovery"
APP_RUN_AT_RS232_DETECT "AppRunAtRs232Detect"
APP_RUN_AFTER_RESTORE "AppRunAfterRestore"

The string values in this table are processed as command line commands. In some cases, the part of the command line that follows the string is treated as a parameter.

Use the CeRunAppAtEvent function sparingly, because automatically starting an application can confuse the user and cause low-memory conditions on a machine with restricted memory. Ideally, the application should be small and non-intrusive.

The following constants are defined in the header file, but they are not supported:

NOTIFICATION_EVENT_ON_AC_POWER

NOTIFICATION_EVENT_OFF_AC_POWER

NOTIFICATION_EVENT_NET_CONNECT

NOTIFICATION_EVENT_NET_DISCONNECT

NOTIFICATION_EVENT_IR_DISCOVERED

When writing applications for Windows CE version 1.0, use the function PegRunAppAtEvent.

See Also

CeRunAppAtTime