NEWCPLINFO structure

Contains resource information and an application-defined value for a dialog box supported by a Control Panel application.

Syntax


typedef struct tagNEWCPLINFO {
  DWORD    dwSize;
  DWORD    dwFlags;
  DWORD    dwHelpContext;
  LONG_PTR lpData;
  HICON    hIcon;
  TCHAR    szName[32];
  TCHAR    szInfo[64];
  TCHAR    szHelpFile[128];
} NEWCPLINFO, *LPNEWCPLINFO;

Members

dwSize

Type: DWORD

The length of the structure, in bytes.

dwFlags

Type: DWORD

This member is ignored.

dwHelpContext

Type: DWORD

This member is ignored.

lpData

Type: LONG_PTR

A pointer to data defined by the application. When the Control Panel sends the CPL_DBLCLK and CPL_STOP messages, it passes this value back to your application.

hIcon

Type: HICON

The identifier of the icon that represents the dialog box. This icon is intended to be displayed by the application that controls the Control Panel application.

szName

Type: TCHAR[32]

A null-terminated string that contains the dialog box name. The name is intended to be displayed below the icon.

szInfo

Type: TCHAR[64]

A null-terminated string containing the dialog box description. The description is intended to be displayed when the icon for the dialog box is selected.

szHelpFile

Type: TCHAR[128]

This member is ignored.

Remarks

The CPlApplet function of the Control Panel application returns this information to the Control Panel in response to a CPL_NEWINQUIRE message.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Cpl.h

See also

CPLINFO

 

 

Show: