DocumentProperties.GetObjects Method

Article
07/12/2014

Returns a list of objects managed by this DocumentProperties object.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)

Syntax

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

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

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

abstract GetObjects : 
        flags:uint32 * 
        count:uint32 * 
        ppUnk:Object[] -> int  
override GetObjects : 
        flags:uint32 * 
        count:uint32 * 
        ppUnk:Object[] -> int

public function GetObjects(
    flags : uint, 
    count : uint, 
    ppUnk : Object[]
) : int

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.

Implements

ISelectionContainer.GetObjects(UInt32, UInt32, array<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.

.NET Framework Security

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.

Share via