Freigeben über


IVsExtensibleObject.GetAutomationObject Method

Returns an automation object.

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: String

    [in] The environment passes a nulla null reference (Nothing in Visual Basic) when an automation consumer calls your automation object.

  • ppDisp
    Type: Object%

    [out] Pointer to the IDispatch interface of the object to be returned.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

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

The environment calls this method when an automation consumer tries to use your the automation object of your VSPackage.

See illustrations of the implementation of this interface in the Basic Edit Sample.

.NET Framework Security

See Also

Reference

IVsExtensibleObject Interface

Microsoft.VisualStudio.Shell.Interop Namespace