NEWCPLINFO

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure contains resource information and a user-defined value for a dialog box supported by a Control Panel application.

Syntax

typedef struct tagNEWCPLINFO { 
  DWORD dwSize; 
  DWORD dwFlags; 
  DWORD dwHelpContext; 
  LONG lData; 
  HICON hIcon; 
  TCHAR szName[32]; 
  TCHAR szInfo[64]; 
  TCHAR szHelpFile[128]; 
} NEWCPLINFO;

Members

  • dwSize
    Specifies the length of the structure, in bytes.
  • dwFlags
    Ignored.
  • dwHelpContext
    Ignored.
  • lData
    Data defined by the application. When the Control Panel sends the CPL_DBCLK and CPL_STOP messages, it passes this value back to your application.
  • hIcon
    Handle to the icon that represents the dialog box. This icon is intended to be displayed by the application that controls the Control Panel application.
  • szName
    Null-terminated string that contains the dialog box name. The name is intended to be displayed below the icon.
  • szInfo
    Null-terminated string that contains the dialog box description. The description is intended to be displayed when the icon for the dialog box is selected.
  • szHelpFile
    Ignored.

Remarks

The dwHelpContext and szHelpSize members are not used by the Control Panel Explorer in Windows Embedded CE for the Handheld PC.

For ldata, applications should return the icon resource ID for the control panel. This is the same as hIcon, but the resource ID is being returned instead of the icon handle.

This data structure is filled by the CPlApplet function when it processes the CPL_NEWINQUIRE message for a Control Panel application.

Requirements

Header cpl.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Pocket PC 2000 and later

See Also

Reference

CPLINFO
CPL_NEWINQUIRE

Other Resources