GetRootCategory Method (String, CategoryConfiguration)
Gets the root category object for this catalog. The root category contains the list of all products and categories not contained in other categories.
Namespace: Microsoft.CommerceServer.Catalog
Assembly: Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)
Syntax
'Declaration
Public Function GetRootCategory ( _
catalogName As String, _
config As CategoryConfiguration _
) As Category
'Usage
Dim instance As CatalogContext
Dim catalogName As String
Dim config As CategoryConfiguration
Dim returnValue As Category
returnValue = instance.GetRootCategory(catalogName, _
config)
public Category GetRootCategory(
string catalogName,
CategoryConfiguration config
)
public:
Category^ GetRootCategory(
String^ catalogName,
CategoryConfiguration^ config
)
public function GetRootCategory(
catalogName : String,
config : CategoryConfiguration
) : Category
Parameters
- catalogName
Type: System..::.String
The name of the catalog to query.
- config
Type: Microsoft.CommerceServer.Catalog..::.CategoryConfiguration
A CategoryConfiguration object which specifies the portions of the category to retrieve as well as sort options and filtering.
Return Value
Type: Microsoft.CommerceServer.Catalog..::.Category
A Category object describing the root category of catalog catalogName.
Remarks
Retrieves a category object which represents the “root” category. This category cannot be modified. The root category will not be a member of any collection and has no parent category. The GetRootCategory(catalogName, config) is the same as GetCategory(catalogName, String.Empty, nullNothingnullptra null reference (Nothing in Visual Basic), config) method.
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.