GetCatalog Method (String)
Returns a ProductCatalog for the specified catalog.
Namespace: Microsoft.CommerceServer.Catalog
Assembly: Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)
Syntax
'Declaration
Public Function GetCatalog ( _
catalogName As String _
) As ProductCatalog
'Usage
Dim instance As CatalogContext
Dim catalogName As String
Dim returnValue As ProductCatalog
returnValue = instance.GetCatalog(catalogName)
public ProductCatalog GetCatalog(
string catalogName
)
public:
ProductCatalog^ GetCatalog(
String^ catalogName
)
public function GetCatalog(
catalogName : String
) : ProductCatalog
Parameters
- catalogName
Type: System..::.String
The name of the catalog. Should not be nullNothingnullptra null reference (Nothing in Visual Basic).
Return Value
Type: Microsoft.CommerceServer.Catalog..::.ProductCatalog
A ProductCatalog for the specified catalog.
Exceptions
| Exception | Condition |
|---|---|
| EntityDoesNotExistException | The catalogName does not exist in the catalog system. |
| NotAuthorizedException | The caller is not authorized to perform this operation. |
Remarks
Use this method to retrieve a specified catalog from the Product Catalog System. The ActiveLanguage on the returned ProductCatalog object will be set to the default language of the catalog.
You can use the returned ProductCatalog object to access and update information about the catalog.
The catalog name specified by catalogName should:
Not be nullNothingnullptra null reference (Nothing in Visual Basic) or blank.
Not exceed 85 characters.
Not contain the .,"[]'()# characters.
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.