All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspShareData
System.IUnknown
|
+---CATIPspShareData
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspShareData
Interface to access share data in the catalog.
Role: To access Plant Ship share data from the catalog.
Method Index
- o
List(CATUnicodeString&,CATUnicodeString&,CATListValCATUnicodeString**)
- Retrieve a list of share data ID in the catalog.
- o
ListAttributes(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListValCATUnicodeString**,CATListValCATUnicodeString**,CATLISTP(CATBaseUnknown)**)
- Retrieve a list of attribute values for the share data.
- o
ListQuery(CATUnicodeString&,CATUnicodeString&,CATListValCATUnicodeString**)
- Retrieve a filtered list of share data ID in the catalog based
on an input query string.
Methods
o List
-
Retrieve a list of share data ID in the catalog.
- Parameters:
-
- iResourceName
- Resource name for Catalog
- iShareDataType
- Share Data Type filter.
If null, no filtering will be applied
- oListOfShareDataID
- List of Share Data ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListAttributes
-
Retrieve a list of attribute values for the share data.
- Parameters:
-
- iCatalogResourceName
- Resource name for Catalog
- iAttrFilterResourceName
- Resource name for attribute filtering text file
- iShareDataID
- Share Data Identification.
- oListOfAttrNames
- List of attribute names
- oListOfAttrValues
- List of attribute values
- oListOfAttrTypes
- List of attribute types
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListQuery
-
Retrieve a filtered list of share data ID in the catalog based
on an input query string.
- Parameters:
-
- iResourceName
- Resource name for Catalog
- iQueryExpression
- Query string used to filter the share data ID.
It has a knowledgeware syntax.
If null, no filtering will be applied
- oListOfShareDataID
- List of Share Data ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspShareData.h