OLEUIGNRLPROPSA structure (oledlg.h)

Initializes the General tab of the Object Properties dialog box. A reference to it is passed in as part of the OLEUIOBJECTPROPS structure to the OleUIObjectProperties function. This tab shows the type and size of an OLE embedding and allows it the user to tunnel to the Convert dialog box. This tab also shows the link destination if the object is a link.

Syntax

typedef struct tagOLEUIGNRLPROPSA {
  DWORD                       cbStruct;
  DWORD                       dwFlags;
  DWORD                       dwReserved1[2];
  LPFNOLEUIHOOK               lpfnHook;
  LPARAM                      lCustData;
  DWORD                       dwReserved2[3];
  struct tagOLEUIOBJECTPROPSA *lpOP;
} OLEUIGNRLPROPSA, *POLEUIGNRLPROPSA, *LPOLEUIGNRLPROPSA;

Members

cbStruct

The size of the structure, in bytes. This field must be filled on input.

dwFlags

Currently no flags associated with this member. It should be set to 0 (zero).

dwReserved1[2]

This member is reserved.

lpfnHook

Pointer to a hook function that processes messages intended for the dialog box. The hook function must return zero to pass a message that it didn't process back to the dialog box procedure in the library. The hook function must return a nonzero value to prevent the library's dialog box procedure from processing a message it has already processed.

lCustData

Application-defined data that the library passes to the hook function pointed to by the lpfnHook member during WM_INITDIALOG.

dwReserved2[3]

This member is reserved.

lpOP

Used internally.

Remarks

Note

The oledlg.h header defines OLEUIGNRLPROPS as an alias which 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 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

OLEUIOBJECTPROPS

OleUIObjectProperties