IVsExtensibleObject.GetAutomationObject Method

Article
04/22/2008

Returns an automation object.

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

Syntax

'Déclaration
Function GetAutomationObject ( _
    pszPropName As String, _
    <OutAttribute> ByRef ppDisp As Object _
) As Integer
'Utilisation
Dim instance As IVsExtensibleObject
Dim pszPropName As String
Dim ppDisp As Object
Dim returnValue As Integer

returnValue = instance.GetAutomationObject(pszPropName, _
    ppDisp)

int GetAutomationObject(
    string pszPropName,
    out Object ppDisp
)

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

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

Parameters

pszPropName
Type: System.String

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

ppDisp
Type: System.Object%

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

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

Permissions

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.

Partager via