IVsPackage.GetPropertyPage Method

Article
05/06/2010

Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.

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

Syntax

'Déclaration
Function GetPropertyPage ( _
    ByRef rguidPage As Guid, _
    <OutAttribute> ppage As VSPROPSHEETPAGE() _
) As Integer
'Utilisation
Dim instance As IVsPackage
Dim rguidPage As Guid
Dim ppage As VSPROPSHEETPAGE()
Dim returnValue As Integer

returnValue = instance.GetPropertyPage(rguidPage, _
    ppage)

int GetPropertyPage(
    ref Guid rguidPage,
    VSPROPSHEETPAGE[] ppage
)

int GetPropertyPage(
    [InAttribute] Guid% rguidPage, 
    [InAttribute] [OutAttribute] array<VSPROPSHEETPAGE>^ ppage
)

abstract GetPropertyPage : 
        rguidPage:Guid byref * 
        ppage:VSPROPSHEETPAGE[] byref -> int

function GetPropertyPage(
    rguidPage : Guid, 
    ppage : VSPROPSHEETPAGE[]
) : int

Parameters

rguidPage
Type: System.Guid%
[in] Unique identifier of the requested property page.

ppage
Type: array<Microsoft.VisualStudio.Shell.Interop.VSPROPSHEETPAGE[]
[in, out] Pointer to the property page whose values are taken from the VSPROPSHEETPAGE structure.

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 IVsPackage::GetPropertyPage(
   [in] REFGUID rguidPage,
   [in, out] VSPROPSHEETPAGE *ppage
);

Pages used in the ppage parameter are not IPropertyPage property pages, but Microsoft Windows API PROPSHEETPAGE pages, which are used for Options and Customize Toolbox pages.

This method is called by the environment to display property pages when implementing custom Tools Options pages or adding a new pages to the Customize Toolbox dialog. For more information on implementing custom Tools Options pages and new Customize Toolbox dialogs, see Options Pages and Toolbox (Visual Studio SDK).

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

Partager via