CatalogManager3.Catalogs Property (PIA)
The Catalogs property is a read-only Recordset object that describes all the catalogs in the Product Catalog System. The returned Recordset object includes the properties of each catalog.
Definition
[Visual Basic .NET]
Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib ‘ for _Recordset
…
Public ReadOnly Property Catalogs(
Optional strSearchPhrase As String,
Optional lStartingRecord As Object,
Optional lNumRecords As Object,
Optional strLanguage As String,
Optional plTotalRecordsInQuery As Object)As _Recordset
[C#]
using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib; //For _Recordset
…
public _Recordset get_Catalogs(
stringstrSearchPhrase,
objectlStartingRecord,
objectlNumRecords,
stringstrLanguage,
ref object plTotalRecordsInQuery);
Parameters
[Visual Basic .NET]
- strSearchPhrase
A String that contains the search phrase. - lStartingRecord
An Object that contains the starting record. A value of one (1) indicates the first record. - lNumRecords
An Object that contains the number of records requested. - strLanguage
A String that contains the ISO 639+1 language identifier. See the Remarks section for the usage of this parameter. - plTotalRecordsInQuery
An Object used to return the total number of catalogs that match the search phrase.
[C#]
- strSearchPhrase
A string that contains the search phrase. - lStartingRecord
An object that contains the starting record. A value of one (1) indicates the first record. - lNumRecords
An object that contains the number of records requested. - strLanguage
A string that contains the ISO 639+1 language identifier. See the Remarks section for the usage of this parameter. - plTotalRecordsInQuery
An object used to return the total number of catalogs that match the search phrase.
[C#]
Return Values
This method returns an ADODB26Lib._Recordset interface to a Recordset object used to return the catalogs.
Exceptions
This property may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.
The following table shows the custom COM errors that a COMException can wrap.
| Constant | Value | Description |
|---|---|---|
| E_CAT_CATMGR_NOT_INITIALIZED | [C#] 0x889800B5 [Visual Basic .NET] &H889800B5 |
The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method. |
| E_CAT_INVALID_RS_POINTER | [C#] 0x889800B7 [Visual Basic .NET] &H889800B7 |
The recordset pointer that you specified is invalid. |
| E_INVALIDARG | [C#] 0x80070057 [Visual Basic .NET] &H80070057 |
One or more arguments are invalid. |
| E_CAT_INVALID_SEARCH_CLAUSE | [C#] 0x8898011C [Visual Basic .NET] &H8898011C |
The search condition that you specified is invalid for one of the following reasons
|
Remarks
The recordset returned by this property is valid only if it is accessed successfully.
get_Catalogs does not show up in IntelliSense.
The returned recordset contains the following fields:
| Field Name | Data Type | Description |
|---|---|---|
| CatalogName | String 128 characters |
None |
| Locale | Integer | None |
| StartDate | DateTime | None |
| EndDate | DateTime | None |
| VariantID | String 128 characters |
The name of the property that uniquely identifies a product variant. |
| ProductID | String 128 characters |
The name of the property that uniquely identifies a product. |
| Currency | String 128 characters |
None |
| WeightMeasure | String 128 characters |
None |
| TimeStamp | Timestamp | None |
| CatalogID | Integer | The number that uniquely identifies a catalog. |
| CustomCatalog | Bit | A flag indicating whether this is a custom catalog. |
| FreeTextIndexCreated | DateTime | None |
| ProductTableUpdated | DateTime | None |
Requirements
Namespace: Microsoft.CommerceServer.Interop.Catalog
Platforms: Windows 2000, Windows Server 2003
Assembly: cataloglib (in cataloglib.dll)
See Also
Copyright © 2005 Microsoft Corporation.
All rights reserved.