Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Properties property is a read-only recordset that returns the name of each property that currently exists in the Product Catalog System. If the catalog name is specified, only properties used in that catalog are returned.
Definition
[C++]
HRESULT ICatalogManager3::Properties(VARIANTstrCatalogName,
_Recordset**ppRSProperties);
[Visual Basic]
Function Properties(Optional strCatalogName As Variant) As _Recordset
Parameters
- strCatalogName[C++]
[in, optional] A VARIANT that contains the name of the catalog for which the properties are returned. If this optional parameter is omitted, all properties are returned. - strCatalogName[Visual Basic]
A Variant that contains the name of the catalog for which the properties are returned. If this optional parameter is omitted, all properties are returned. - ppRSProperties[C++]
[out] A pointer to a _Recordset object used to return the properties.
[C++]
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
Error Values
[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
The following table describes the custom COM errors this method can return.
| Name | Value | Description |
|---|---|---|
| E_CAT_CATMGR_NOT_INITIALIZED | [C++] 0x889800B [Visual Basic] &H8898005 |
The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method. |
| E_CAT_INVALID_RS_POINTER | [C++] 0x889800B [Visual Basic] &H8898007 |
The recordset pointer that you specified is invalid |
Remarks
[C++] The Properties parameter contains valid data only if the property was accessed successfully.
[Visual Basic] The Recordset object contains valid data only if the property was accessed successfully.
[C++] This method returns a Recordset object containing a row for each property returned. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.
[Visual Basic] This method returns a Recordset object containing a row for each property returned. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
[Visual Basic]
Example
Set rsProps = myCatalogManager.Properties ("ShoesCatalog")
See Also
[Visual Basic]CatalogManager Object
[C++]ICatalogManager3::CreateProperty
[Visual Basic]CatalogManager.CreateProperty
[C++]ICatalogManager3::DeleteProperty
[Visual Basic]CatalogManager.DeleteProperty
Copyright © 2005 Microsoft Corporation.
All rights reserved.