DocumentProperties::GetObjects Method (UInt32, UInt32, array<Object^>^)

 

Returns a list of objects managed by this DocumentProperties object.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

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

Parameters

flags
Type: System::UInt32

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

count
Type: System::UInt32

[in] The maximum number of objects to return.

ppUnk
Type: array<System::Object^>^

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

Return Value

Type: System::Int32

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

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.

Return to top
Show: