DocumentProperties.GetObjects(UInt32, UInt32, Object[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Returns a list of objects managed by this DocumentProperties object.

public:
 virtual int GetObjects(System::UInt32 flags, System::UInt32 count, cli::array <System::Object ^> ^ ppUnk);

public:
 virtual int GetObjects(unsigned int flags, unsigned int count, Platform::Array <Platform::Object ^> ^ ppUnk);

 virtual int GetObjects(unsigned int flags, unsigned int count, std::Array <winrt::Windows::Foundation::IInspectable const &> const & ppUnk);

public virtual int GetObjects (uint flags, uint count, object[] ppUnk);

abstract member GetObjects : uint32 * uint32 * obj[] -> int
override this.GetObjects : uint32 * uint32 * obj[] -> int

Public Overridable Function GetObjects (flags As UInteger, count As UInteger, ppUnk As Object()) As Integer

Parameters

flags

UInt32

[in] This is either GETOBJS_ALL to get all objects, or GETOBJS_SELECTED to get only the selected objects.

count

UInt32

[in] The maximum number of objects to return.

ppUnk

Object[]

[in, out] An array that is filled in with the objects to return.

Returns

Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

GetObjects(UInt32, UInt32, Object[])

Remarks

This method is used in managing multiple objects in the Properties window. A language service typically needs only the one DocumentProperties object and the base method handles this automatically.

This method is an implementation of the GetObjects method on the ISelectionContainer interface.

The base method returns the DocumentProperties object if the count parameter is 1. The base method always returns a success code of S_OK.