Share via


IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[]) Method

Definition

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

public:
 int GetPropertyPage(Guid % rguidPage, cli::array <Microsoft::VisualStudio::Shell::Interop::VSPROPSHEETPAGE> ^ ppage);
public int GetPropertyPage (ref Guid rguidPage, Microsoft.VisualStudio.Shell.Interop.VSPROPSHEETPAGE[] ppage);
abstract member GetPropertyPage : Guid * Microsoft.VisualStudio.Shell.Interop.VSPROPSHEETPAGE[] -> int
Public Function GetPropertyPage (ByRef rguidPage As Guid, ppage As VSPROPSHEETPAGE()) As Integer

Parameters

rguidPage
Guid

[in] Unique identifier of the requested property page.

ppage
VSPROPSHEETPAGE[]

[in, out] Pointer to the property page whose values are taken from the VSPROPSHEETPAGE structure.

Returns

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 Extending the Toolbox.

Applies to