PersistentPacket (Windows Embedded CE 6.0)

1/6/2010

This structure contains the information about a notification as recorded in the notification database.

Syntax

union PersistentPacket {
  struct {
    DWORD dwActionFlags;
    DWORD dwPacketFlags;
    FILETIME ftStart;
    FILETIME ftStop;
    union {
      unsigned int uiAppNameOffset;
      WCHAR* lpszAppName;
    };
    union {
      unsigned int uiCmdLineOffset;
      WCHAR* lpszCmdLine;
    };
    union {
      unsigned int uiDialogTitleOffset;
      WCHAR*     lpszDialogTitle;
    };
    union {
      unsigned int uiDialogTextOffset;
      WCHAR* lpszDialogText;
    };
    union {
      unsigned int uiSoundOffset;
      WCHAR* lpszSound;
    };
    union {
      unsigned int uiExpansionOffset;
      void* pvExpansionData;
    };
    unsigned char header_end[1];
  };
  unsigned char packet_start[1]; 
};

Members

• dwActionFlags
  Describes the type of action required for the notification. It can be a combination of any of the following flags.

  Flag	Description
  PUN_LED	Set if the LED should flash when the notification occurs.
  PUN_VIBRATE	Set if the device should vibrate.
  PUN_DIALOG	Set if a dialog should be displayed. The application must provide title and text when calling CeSetUserNotification.
  PUN_SOUND	Set if the sound specified in pwszSound should be played.
  PUN_REPEAT	Set if the sound specified in pwszSound should be repeated progressively.
  PUN_PRIVATE	Set if the notification dialog box should be displayed behind the password.

• dwPacketFlags
  Describes the type of event. It can be set to one of the following flags.

  Flag	Description
  CNT_EVENT	System event notification.
  CNT_TIME	Time-based notification.
  CNT_PERIOD	Time-based notification that is active for the time period from ftStart to ftEnd.
  CNT_CLASSICTIME	Equivalent to using the CeSetUserNotification function, which is now obsolete. This is provided to preserve backward compatibility with older applications.

• ftStart
  Beginning of the notification period in FILETIME.

• ftStop
  End of the notification period in FILETIME.

uiAppNameOffset

• lpszAppName
  Identifies the application name associated with the event. The notification engine uses uiAppNameOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiAppNameOffset to store the application name in lpszAppName.

uiCmdLineOffset

• lpszCmdLine
  Identifies the application command line associated with the event. The notification engine uses uiCmdLineOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiCmdLineOffsetto store the command line in lpszCmdLine.

uiDialogTitleOffset

• lpszDialogTitle
  Identifies the title of a dialog associated with the event. The notification engine uses uiDialogTitleOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiDialogTitleOffset to store the dialog title in lpszDialogTitle.

uiDialogTextOffset

• lpszDialogText
  Identifies the text to be used in a dialog associated with the event. The notification engine uses uiDialogTextOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiDialogTextOffset to store the dialog text in lpszDialogText.

uiSoundOffset

• lpszSound
  Identifies the sound associated with the event. The notification engine uses uiSoundOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiSoundOffset to store the sound in lpszSound.

uiExpansionOffset

• pvExpansionData
  Identifies the additional data associated with the event. The notification engine uses uiExpansionOffset internally, so OEM code should ignore this parameter. When OEM code receives a packet, the notification engine uses uiExpansionOffset to store the additional data in pvExpansionData.

• header_end
  Used by the notification engine only. OEM code should ignore this parameter.

• packet_start
  Used by the notification engine only. OEM code should ignore this parameter.

Requirements

See Also

Reference

Notification Structures