OLEUIOBJECTPROPSA structure (oledlg.h)

Contains information that is used to initialize the standard Object Properties dialog box. It contains references to interfaces used to gather information about the embedding or link, references to three structures that are used to initialize the default tabs - General (OLEUIGNRLPROPS), View (OLEUIVIEWPROPS), and Link (OLEUILINKPROPS), if appropriate - and a standard property-sheet extensibility interface that allows the caller to add additional custom property sheets to the dialog box.

Syntax

typedef struct tagOLEUIOBJECTPROPSA {
  DWORD              cbStruct;
  DWORD              dwFlags;
  LPPROPSHEETHEADERA lpPS;
  DWORD              dwObject;
  LPOLEUIOBJINFOA    lpObjInfo;
  DWORD              dwLink;
  LPOLEUILINKINFOA   lpLinkInfo;
  LPOLEUIGNRLPROPSA  lpGP;
  LPOLEUIVIEWPROPSA  lpVP;
  LPOLEUILINKPROPSA  lpLP;
} OLEUIOBJECTPROPSA, *POLEUIOBJECTPROPSA, *LPOLEUIOBJECTPROPSA;

Members

cbStruct

The size of the structure, in bytes.

dwFlags

Contains in/out global flags for the property sheet.

Value	Meaning
OPF_OBJECTISLINK	Object is a link object and therefore has a link property page.
OPF_NOFILLDEFAULT	Do not fill in default values for the object.
OPF_SHOWHELP	The dialog box will display a Help button.
OPF_DISABLECONVERT	The Convert button will be disabled on the general property page.

lpPS

Pointer to the standard property sheet header (PROPSHEETHEADER), used for extensibility.

dwObject

Identifier for the object.

lpObjInfo

Pointer to the interface to manipulate object.

dwLink

Container-defined unique identifier for a single link. Containers can use the pointer to the link's container site for this value.

lpLinkInfo

Pointer to the interface to manipulate link.

lpGP

Pointer to the general page data.

lpVP

Pointer to the view page data.

lpLP

Pointer to the link page data.

Remarks

Note

The oledlg.h header defines OLEUIOBJECTPROPS as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	oledlg.h

See also

OLEUIGNRLPROPS

OLEUILINKPROPS

OLEUIVIEWPROPS

OleUIObjectProperties