_SiteConfig::GetResourcePropAttrib Method
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Note
This object is obsolete. Use SiteConfigFreeThreaded instead.
Use this method to get a Dictionary object of key/value pairs that denote the attributes of the specified property of the specified resource.
HRESULT _SiteConfig::GetResourcePropAttrib(
BSTR strResourceName,
BSTR strPropName,
IDictionary** idictResPropAttrib
);
Function GetResourcePropAttrib(
strResourceName As String,
strPropName As String
) As Object
Parameters
strResourceName
[C++][in] A BSTR that contains the resource name.
[Visual Basic]
A String that contains the resource name.
strPropName
[C++][in] A BSTR that contains the resource property name.
[Visual Basic]
A String that contains the resource property name.
idictResPropAttrib
[C++][out, retval] The address of a pointer to receive an IDictionary interface, used to return the key/value pairs that denote the attributes of the specified property of the specified resource.
Return Value
[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 an object reference to a Dictionary object containing the key/value pairs that denote the attributes of the specified property of the specified resource.
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.
All ADO, SQL Server, and ODBC errors will also be returned by this method.
Remarks
The Initialize method must be called before this method can be used.
The idictResPropAttrib parameter contains valid data only if the method completes successfully.
Example
' dDict is a Dictionary object.
' sMyCatalog is an existing resource.
' connstr_desc_Catalog is a valid Catalog resource property.
' oSiteConfig is a SiteConfig object.
dDict = _
oSiteConfig.GetResourcePropAttrib(sMyCatalog, connstr_desc_Catalog)