Edit

Share via

COMPONENT structure (shlobj_core.h)

  • Article

Used by Windows 2000 to hold information about a component. This structure replaces the IE4COMPONENT structure.

Syntax

typedef struct _tagCOMPONENT {
  DWORD         dwSize;
  DWORD         dwID;
  int           iComponentType;
  BOOL          fChecked;
  BOOL          fDirty;
  BOOL          fNoScroll;
  COMPPOS       cpPos;
  WCHAR         wszFriendlyName[MAX_PATH];
  WCHAR         wszSource[INTERNET_MAX_URL_LENGTH];
  WCHAR         wszSubscribedURL[INTERNET_MAX_URL_LENGTH];
  DWORD         dwCurItemState;
  COMPSTATEINFO csiOriginal;
  COMPSTATEINFO csiRestored;
} COMPONENT;

Members

dwSize

Type: DWORD

The size of the structure.

dwID

Type: DWORD

Reserved. Set to zero.

iComponentType

Type: int

The component type. It can take one of the following values.

COMP_TYPE_HTMLDOC

HTML document

COMP_TYPE_PICTURE

Picture

COMP_TYPE_WEBSITE

Website

COMP_TYPE_CONTROL

ActiveX control. This value is valid only for IActiveDesktop::AddDesktopItem.

fChecked

Type: BOOL

A value that is set to TRUE if the component is enabled, or FALSE if it's not.

fDirty

Type: BOOL

A value that is set to TRUE if the component has been modified and not yet saved to disk. It will be set to FALSE if the component has not been modified, or if it has been modified and saved to disk.

fNoScroll

Type: BOOL

A value that is set to TRUE if the component is scrollable, or FALSE if not.

cpPos

Type: COMPPOS

A COMPPOS structure containing position and size information.

wszFriendlyName[MAX_PATH]

Type: WCHAR[MAX_PATH]

The component's friendly name.

wszSource[INTERNET_MAX_URL_LENGTH]

Type: WCHAR[INTERNET_MAX_URL_LENGTH]

The component's URL.

wszSubscribedURL[INTERNET_MAX_URL_LENGTH]

Type: WCHAR[INTERNET_MAX_URL_LENGTH]

The subscribed URL.

dwCurItemState

Type: DWORD

The current state of the component. It can take one of the following values.

IS_NORMAL

Normal screen

IS_FULLSCREEN

Full screen

IS_SPLIT

Split screen

csiOriginal

Type: COMPSTATEINFO

A COMPSTATEINFO structure with the state of the component when it was first added.

csiRestored

Type: COMPSTATEINFO

A COMPSTATEINFO structure with the restored state of the component.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header shlobj_core.h (include Shlobj.h)