IOleUIObjInfoA::GetConvertInfo method (oledlg.h)

Article
02/22/2024

Gets the conversion information associated with the specified object.

Syntax

HRESULT GetConvertInfo(
  [in]  DWORD   dwObject,
  [out] CLSID   *lpClassID,
  [out] WORD    *lpwFormat,
  [out] CLSID   *lpConvertDefaultClassID,
  [out] LPCLSID *lplpClsidExclude,
  [out] UINT    *lpcClsidExclude
);

Parameters

[in] dwObject

Unique identifier for the object.

[out] lpClassID

Pointer to the location to return the object's CLSID.

[out] lpwFormat

Pointer to the clipboard format of the object.

[out] lpConvertDefaultClassID

Pointer to the default class, selected from the UI, to convert the object to.

[out] lplpClsidExclude

Address of a pointer variable that receives a pointer to an array of CLSIDs that should be excluded from the user interface for this object. If lpcClsidExclude is zero, then lpClsidExclude is set to NULL.

[out] lpcClsidExclude

Address of an output variable that receives the number of CLSIDs in lplpClsidExclude. This parameter may be zero.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return code	Description
E_ACCESSDENIED	Insufficient access permissions.
E_FAIL	The operation failed.
E_INVALIDARG	The specified identifier is invalid.
E_OUTOFMEMORY	There is insufficient memory available for this operation.

Remarks

Notes to Implementers

You must fill in the CLSID of the object at a minimum. lpwFormat may be left at zero if the format of the storage is unknown.

Requirements

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

Share via