IVsMenuItem.IMIGetExtraProps(IStream) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets menu item properties not directly handled by the menu editor (IVsMenuEditor).

public:
 int IMIGetExtraProps(Microsoft::VisualStudio::OLE::Interop::IStream ^ pstm);

public:
 int IMIGetExtraProps(Microsoft::VisualStudio::OLE::Interop::IStream ^ pstm);

int IMIGetExtraProps(Microsoft::VisualStudio::OLE::Interop::IStream const & pstm);

public int IMIGetExtraProps (Microsoft.VisualStudio.OLE.Interop.IStream pstm);

abstract member IMIGetExtraProps : Microsoft.VisualStudio.OLE.Interop.IStream -> int

Public Function IMIGetExtraProps (pstm As IStream) As Integer

Parameters

pstm: IStream

[in] Pointer to a stream (IStream interface).

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Implementing this method and IMISetExtraProps enables the menu editor to perform all clipboard operations, including those with otherwise unknown properties. You must write all property values to the stream.

If your form designer does not have extra properties, return E_NOTIMPL in response to IMIGetExtraProps.

IVsMenuEditor includes the site id in clipboard data so that it will not attempt to paste extra properties from one site to another site.

COM Signature

From vsshell.idl:

HRESULT IVsMenuItem::IMIGetExtraProps(  
   [in]LPSTREAM pstm  
);

Applies to