ICategorizeProperties.GetCategoryName(Int32, UInt32, String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Returns a BSTR containing the category name.

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

Parameters

PROPCAT
Int32

[in] Specifies the property category.

lcidCategory
UInt32
pbstrName
String

[out] Pointer to a string containing the category name.

Returns

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

Applies to