Package.IVsPackage.GetAutomationObject Method (String, Object)

 

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an automation-friendly object for this package.

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

int IVsPackage.GetAutomationObject(
	string propName,
	out object auto
)

Parameters

propName
Type: System.String

String containing the automation property name.

auto
Type: System.Object

[out] Returns the automation object.

Return Value

Type: System.Int32

If the method succeeds, S_OK, otherwise an error code.

The default implementation will return auto as null if propName is null, indicating that there is no default automation object. If propName is non-null, it will walk the metadata attributes searching for an options page that has a name of the format: <Category>.<Name>. If the options page has this format and indicates that it supports automation, its automation object will be returned.

Return to top
Show: