OLEUIINSERTOBJECT - OLE Programmer's Reference (ole.hlp)

OLEUIINSERTOBJECT

The OLEUIINSERTOBJECT structure contains information that the OLE 2.01 User Interface Library uses to initialize the Insert Object dialog box, and space for the library to return information when the dialog is dismissed.

typedef struct tagOLEUIINSERTOBJECT
{
// These IN fields are standard across all OLEUI dialog functions.
DWORD cbStruct;
DWORD dwFlags;
HWND hWndOwner;
LPCSTR lpszCaption;
LPFNOLEUIHOOK lpfnHook;
LPARAM lCustData;
HINSTANCE hInstance;
LPCSTR lpszTemplate;
HRSRC hResource;
CLSID clsid;

// Specifics for OLEUIINSERTOBJECT.
LPTSTR lpszFile;
UINT cchFile;
UINT cClsidExclude;
LPCLSID lpClsidExclude;
IID iid;

// Specific to create objects if flags say so
DWORD oleRender;
LPFORMATETC lpFormatEtc;
LPOLECLIENTSITE lpIOleClientSite;
LPSTORAGE lpIStorage;
LPVOID FAR * ppvObj;
SCODE sc;
HGLOBAL hMetaPict;
} OLEUIINSERTOBJECT, *POLEUIINSERTOBJECT, FAR *LPOLEUIINSERTOBJECT;

Members
cbStruct

Size of the structure in bytes. This field must be filled on input.

dwFlags

On input, specifies the initialization and creation flags. On exit, specifies the user's choices. It can be a combination of the following flags:

IOF_SHOWHELP

Specifies that the dialog will display a Help button.

IOF_SELECTCREATENEW

Specifies that the Create New radio button will initially be checked. This cannot be used with IOF_SELECTCREATEFROMFILE.

IOF_SELECTCREATEFROMFILE

Specifies that the Create From File radio button will initially be checked. This cannot be used with IOF_SELECTCREATENEW.

IOF_CHECKLINK

Specifies that the Link check box will initially be checked.

IOF_CHECKDISPLAYASICON

Specifies that the Display As Icon check box will initially be checked, the current icon will be displayed, and the Change Icon button will be enabled.

IOF_CREATENEWOBJECT

Specifies that a new object should be created when the user selects OK to dismiss the dialog box and the Create New radio button was selected.

IOF_CREATEFILEOBJECT

Specifies that a new object should be created from the specified file when the user selects OK to dismiss the dialog box and the Create From File radio button was selected.

IOF_CREATELINKOBJECT

Specifies that a new linked object should be created when the user selects OK to dismiss the dialog box and the user checked the Link check box.

IOF_DISABLELINK

Specifies that the Link check box will be disabled on initialization.

IOF_VERIFYSERVERSEXIST

Specifies that the dialog box should validate the classes it adds to the listbox by ensuring that the server specified in the registration database exists. This is a significant performance factor.

IOF_DISABLEDISPLAYASICON

Specifies that the Display As Icon check box will be disabled on initialization.

IOF_HIDECHANGEICON

Hides the Change Icon button in the Insert Object dialog.

IOF_SHOWINSERTCONTROL

Displays the Insert Control radio button.

IOF_SELECTCREATECONTROL

Displays the Create Control radio button.

hWndOwner

Identifies the window that owns the dialog box. It should not be NULL.

lpszCaption

Points to a string to be used as the title of the dialog box. If NULL, then the library uses Insert Object.

lpfnHook

Points 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 non zero value to prevent the library's dialog box procedure from processing a message it has already processed.

lCustData

Specifies application-defined data that the library passes to the hook function pointed to by the lpfnHook member. The library passes a pointer to the OLEUIINSERTOBJECT structure in the lParam parameter of the WM_INITDIALOG message; this pointer can be used to retrieve the lCustData member.

hInstance

Identifies an instance that contains a dialog box template specified by the lpTemplateName member.

lpszTemplate

Points to a null-terminated string that specifies the name of the resource file for the dialog box template that is to be substituted for the library's Insert Object dialog box template.

hResource

A customized template handle.

clsid

CLSID for class of the object to be inserted. Filled on output.

lpszFile

Points to the name of the file linked to or insert. Filled on output.

cchFile

The size of lpszFile buffer; will not exceed OLEUI_CCHPATHMAX.

cClsidExclude

The number of CLSIDs included in the lpClsidExclude list. Filled on input.

lpClsidExclude

A list of CLSIDs to exclude from listing.

iid

The identifier of the requested interface. If OleUIInsertObject creates the object, then it will return a pointer to this interface. This parameter is ignored if OleUIInsertObject does not create the object.

oleRender

The rendering option. If OleUIInsertObject creates the object, then it selects the rendering option when it creates the object. This parameter is ignored if OleUIInsertObject does not create the object.

lpFormatEtc

The desired format. If OleUIInsertObject creates the object, then it selects the format when it creates the object. This parameter is ignored if OleUIInsertObject does not create the object.

lpIOleClientSite

Points to the client site to be used for the object. This parameter is ignored if OleUIInsertObject does not create the object.

lpIStorage

Points to the storage to be used for the object This parameter is ignored if OleUIInsertObject does not create the object.

ppvObj

Points to the location where the pointer to the object is returned. This parameter is ignored if OleUIInsertObject does not create the object.

The result of creation calls. This parameter is ignored if OleUIInsertObject does not create the object.

hMetaPict

MetafilePict structure containing the iconic aspect, if it wasn't placed in the object's cache.