ICatalogManager3::GetPropertyAttributes Method [C++]

Article
11/12/2009

Use this method to return the attributes of the specified property.

Definition

[C++]

HRESULT ICatalogManager3::GetPropertyAttributes(BSTRstrPropertyName,
  _Recordset**ppRSAttributes);

[Visual Basic]

Function GetPropertyAttributes(strPropertyName As String) As _Recordset

Parameters

strPropertyName[C++]
[in] A BSTR that contains the name of the property whose attributes will be returned.
strPropertyName[Visual Basic]
A String that contains the name of the property whose attributes will be returned.
ppRSAttributes[C++]
[out] A pointer to a _Recordset object used to return the attributes of the property.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Recordset object that contains the list of attributes for the specified property

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 method 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
E_CAT_INVALID_PROPERTY_NAME	[C++] 0x889800A [Visual Basic] &H8898002	The PropertyName you specified is invalid. property Names cannot be blank and cannot exceed 100 characters. property names cannot begin with a digit and cannot contain one of the following five reserved characters .,"[]

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

E_CAT_INVALID_PROPERTY_NAME

[C++] 0x889800A

[Visual Basic] &H8898002

The PropertyName you specified is invalid. property Names cannot be blank and cannot exceed 100 characters. property names cannot begin with a digit and cannot contain one of the following five reserved characters .,"[]

Remarks

[C++] The ppRSAttributes parameter contains valid data only if the method completes successfully.

[Visual Basic] The recordset returned by this method contains valid data only if the method completes successfully.

[C++] This method returns a single row Recordset object containing the requested property. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.

[Visual Basic] This method returns a single row Recordset object containing the requested property. 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.