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

OLEUICONVERT

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

typedef struct tagOLEUICONVERT

{

// 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

// Specifics for OLEUICONVERT.

CLSID clsid;

CLSID clsidConvertDefault;

CLSID clsidActivateDefault;

CLSID clsidNew;

DWORD dvAspect;

WORD wFormat;

BOOL fIsLinkedObject;

HGLOBAL hMetaPict;

LPTSTR lpszUserType;

BOOL fObjectsIconChanged;

LPTSTR lpszDefLabel

UINT cClsidExclude

LPCLSID lpClsidExclude

} OLEUICONVERT, *POLEUICONVERT, FAR *LPOLEUICONVERT;

Members
cbStruct

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

dwFlags

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

CF_SHOWHELPBUTTON

Specifies that the dialog will display a Help button. This flag is set on input.

CF_SETCONVERTDEFAULT

Specifies that the class whose CLSID is specified by clsidConvertDefault will be used as the default selection. This selection appears in the class listbox when the Convert To radio button is selected. This flag is set on input.

CF_SETACTIVATEDEFAULT

Specifies that the class whose CLSID is specified by clsidActivateDefault will be used as the default selection. This selection appears in the class listbox when the Activate As radio button is selected. This flag is set on input.

CF_SELECTCONVERTTO

On input, this flag specifies that Convert To will be initially selected (default behavior). This flag is set on output if Convert To was selected when the user dismissed the dialog.

CF_SELECTACTIVATEAS

On input, this flag specifies that Activate As will be initially selected. This flag is set on output if Activate As was selected when the user dismissed the dialog.

CF_DISABLEDISPLAYASICON

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

CF_DISABLEACTIVATEAS

Specifies that the Activate As radio button will be disabled on initialization.

CF_HIDECHANGEICON

Hides the Change Icon button in the Convert dialog.

CF_CONVERTONLY

Disables the Activate As radio button in the Convert dialog.

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 Convert.

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 OLEUICONVERT structure in the lParam parameter of the WM_INITDIALOG message; this pointer can be used to retrieve the lCustData member.

hInstance

Identifies a instance that contains a dialog box template specified by the lpszTemplate member. This member is ignored if the lpszTemplate member is NULL or invalid.

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 Convert dialog box template.

hResource

The resource handle for a custom dialog. If this member is NULL, then the library uses the standard Convert dialog template, or if it is valid, the template named by the lpszTemplate member.

clsid

The CLSID of the object to be converted or activated. This member is set on input.

clsidConvertDefault

The CLSID to use as the default class when Convert To is selected. This member is ignored if the dwFlags member does not include CF_SETCONVERTDEFAULT. This member is set on input.

clsidActivateDefault

The CLSID to use as the default class when Activate As is selected. This member is ignored if the dwFlags member does not include CF_SETACTIVATEDEFAULT. This member is set on input.

clsidNew

The CLSID of the selected class. This member is set on output.

dvAspect

The aspect of the object. This must be either DVASPECT_CONTENT or DVASPECT_ICON. If dvAspect is DVASPECT_ICON on input, then the Display As Icon box is checked and the object's icon is displayed. This member is set on input and output.

wFormat

The data format of the object to be converted or activated.

fIsLinkedObject

TRUE if the object is linked. This member is set on input.

hMetaPict

The METAFILEPICT containing the iconic aspect. This member is set on input and output.

lpszUserType

The User Type name of the object to be converted or activated. If this value is NULL, then the dialog will retrieve the User Type name from the registry. This string is freed on exit.

fObjectsIconChanged

TRUE if the object's icon changed. (that is, if OleUIChangeIcon was called and not canceled.). This member is set on output.

lpszDefLabel

The default label to use for the icon. If NULL, the short user type name will be used. If the object is a link, the caller should pass the Display Name of the link source. This is freed on exit.

cClsidExclude

The number of CLSIDs in lpClsidExclude.

lpClsidExclude

The list of CLSIDs to exclude from the list.

See Also
OleUIConvert, OleUIChangeIcon

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

greatis just4fun network