IVsMenuItem.IMIGetExtraProps Method

Article
02/04/2013

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function IMIGetExtraProps ( _
    pstm As IStream _
) As Integer

int IMIGetExtraProps(
    IStream pstm
)

int IMIGetExtraProps(
    [InAttribute] IStream^ pstm
)

abstract IMIGetExtraProps : 
        pstm:IStream -> int

function IMIGetExtraProps(
    pstm : IStream
) : int

Parameters

pstm
Type: Microsoft.VisualStudio.OLE.Interop.IStream
[in] Pointer to a stream (IStream interface).

Return Value

Type: System.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
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via