Share via


ICategorizeProperties.GetCategoryName Method

Returns a BSTR containing the category name.

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

Syntax

'Declaration
Function GetCategoryName ( _
    PROPCAT As Integer, _
    lcidCategory As UInteger, _
    <OutAttribute> ByRef pbstrName As String _
) As Integer
int GetCategoryName(
    int PROPCAT,
    uint lcidCategory,
    out string pbstrName
)
int GetCategoryName(
    [InAttribute] int PROPCAT, 
    [InAttribute] unsigned int lcidCategory, 
    [OutAttribute] String^% pbstrName
)
abstract GetCategoryName : 
        PROPCAT:int * 
        lcidCategory:uint32 * 
        pbstrName:string byref -> int 
function GetCategoryName(
    PROPCAT : int, 
    lcidCategory : uint, 
    pbstrName : String
) : int

Parameters

  • PROPCAT
    Type: System.Int32
    [in] Specifies the property category.
  • pbstrName
    Type: System.String%
    [out] Pointer to a string containing the category name.

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 objext.idl:

HRESULT ICategorizeProperties::GetCategoryName(
   [in] PROPCAT propcat, 
   [in] LCID lcid, 
   [out] BSTR* pbstrName
);

The GetCategoryName method returns a BSTR containing the category name. There are 11 predefined property categories with negative values. You can define your own custom categories, but you must assign positive values to them. The predefined categories are:

Category

Value

PROPCAT_Nil

-1

PROPCAT_Misc

-2

PROPCAT_Font

-3

PROPCAT_Position

-4

PROPCAT_Appearanc

-5

PROPCAT_Behavior

-6

PROPCAT_Data

-7

PROPCAT_List

-8

PROPCAT_Text

-9

PROPCAT_Scale

-10

PROPCAT_DDE

-11

.NET Framework Security

See Also

Reference

ICategorizeProperties Interface

Microsoft.VisualStudio.Shell.Interop Namespace