Category.GetBuiltInCategory
Method
Description:
Gets the BuiltInCategory value corresponding to the given built-in category identifier.
Gets the BuiltInCategory value corresponding to the given built-in category identifier.
Remarks:
A ForgeTypeId identifies a built-in category if it corresponds to a valid BuiltInCategory value according to Category.IsBuiltInCategory(ForgeTypeId) and Category.GetBuiltInCategoryTypeId(BuiltInCategory).
A ForgeTypeId identifies a built-in category if it corresponds to a valid BuiltInCategory value according to Category.IsBuiltInCategory(ForgeTypeId) and Category.GetBuiltInCategoryTypeId(BuiltInCategory).
Parameters
| Parameter | Type | Description |
|---|---|---|
| categoryTypeId | ForgeTypeId | The built-in category identifier. |
Return Value
| Type | Description |
|---|---|
| BuiltInCategory | The BuiltInCategory value corresponding to the given built-in category identifier. |
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | categoryTypeId is not a built-in category identifier. See Category.IsBuiltInCategory(ForgeTypeId) and Category.GetBuiltInCategoryTypeId(BuiltInCategory). |
| ArgumentNullException | A non-optional argument was null |