IVsPropertyPage.CategoryTitle(UInt32, String) 方法

  • 参考

定义

命名空间:
Microsoft.VisualStudio.Shell.Interop
程序集:
Microsoft.VisualStudio.Shell.Interop.dll
程序集:

返回应在树视图中显示属性页的类别。

public:
 int CategoryTitle(System::UInt32 iLevel, [Runtime::InteropServices::Out] System::String ^ % pbstrCategory);
int CategoryTitle(unsigned int iLevel, [Runtime::InteropServices::Out] std::wstring const & & pbstrCategory);
public int CategoryTitle (uint iLevel, out string pbstrCategory);
abstract member CategoryTitle : uint32 * string -> int
Public Function CategoryTitle (iLevel As UInteger, ByRef pbstrCategory As String) As Integer

参数

iLevel
UInt32

中包含级别的整数。

pbstrCategory
String

[out，retval]一个指针，指向要在其下显示属性页的类别 (文件夹) 。

返回

Int32

如果该方法成功，则它会返回 S_OK。 如果该方法失败，则会返回错误代码。

注解

COM 签名

从 vsshell：

HRESULT IVsPropertyPage::CategoryTitle(  
   [in]UINT iLevel,  
   [out, retval]BSTR *pbstrCategory  
);

如果您的属性页没有类别，并且您希望它在树状视图的顶层上直接显示在适当的顶级类别下，则要么 IPropertyPage 单独实现，要么 E_NOTIMPL 从此方法返回。

  1. 否则，环境首先调用值为零的此方法 iLevel 。

  2. 然后，你可以在树中返回应为此页面最近的直接上级的类别名称。

  3. 然后，环境将调用 iLevel 值为1的值。

  4. 如果希望页面缩进一级，则返回 S_FALSE 。

  5. 环境继续调用此方法，每次增加一个值， iLevel 直到你返回以外的内容 S_OK ，或者你达到环境的支持的内部限制。

返回 E_NOTIMPL 并 S_FALSE 停止处理而不向用户显示错误。 以外的任何值 S_OK 都将导致向用户显示错误信息。

目前，环境仅支持两种级别的类别：

CatLevel1

CatLevel0

PageName

Visual Studio 类别、通用属性和配置属性在层次结构中位于 CatLevel1 之上。 Visual Studio 类别不计为两个级别中的一部分。 不会从返回它们 get_CategoryTitle 。

适用于