IVsPackage.GetAutomationObject Method

Article
03/06/2013

Enables a VSPackage to participate in the DTE automation object model.

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

Syntax

'Declaration
Function GetAutomationObject ( _
    pszPropName As String, _
    <OutAttribute> ByRef ppDisp As Object _
) As Integer

int GetAutomationObject(
    string pszPropName,
    out Object ppDisp
)

int GetAutomationObject(
    [InAttribute] String^ pszPropName, 
    [OutAttribute] Object^% ppDisp
)

abstract GetAutomationObject : 
        pszPropName:string * 
        ppDisp:Object byref -> int

function GetAutomationObject(
    pszPropName : String, 
    ppDisp : Object
) : int

Parameters

pszPropName
Type: System.String
[in] Pointer to a null terminated string containing the prop name.

ppDisp
Type: System.Object%
[out] Pointer to the IDispatch interface.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPackage::GetAutomationObject(
   [in] LPCOLESTR pszPropName,
   [out] IDispatch **ppDisp
);

This method is optional and is implemented by VSPackages that want to extend the DTE Automation object model. Essentially, you can add objects to the DTE and event sources using this method.

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