IVsPackage.GetAutomationObject(String, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

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

public:
 int GetAutomationObject(System::String ^ pszPropName, [Runtime::InteropServices::Out] System::Object ^ % ppDisp);

int GetAutomationObject(std::wstring const & pszPropName, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & ppDisp);

public int GetAutomationObject (string pszPropName, out object ppDisp);

abstract member GetAutomationObject : string * obj -> int

Public Function GetAutomationObject (pszPropName As String, ByRef ppDisp As Object) As Integer

Parameters

pszPropName: String

[in] Pointer to a null terminated string containing the prop name.

ppDisp: Object

[out] Pointer to the IDispatch interface.

Returns

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.

Applies to

Compartilhar via