_SiteConfig::DeleteComponentConfig Method [C++]

Article
11/12/2009

Use this method to delete the Administration database information for the specified resource.

[C++]

HRESULT _SiteConfig::DeleteComponentConfig(BSTRbstrConfigComponentName);

[Visual Basic]

Sub DeleteComponentConfig(bstrConfigComponentName As String)

Parameters

bstrConfigComponentName[C++]
[in] A BSTR that contains the name of the resource associated with the Administration database information to delete.
bstrConfigComponentName[Visual Basic]
A String that contains the name of the resource configuration object to be deleted.

Return Values

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

[Visual Basic] None.

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, and ODBC errors will also be returned by this method.

Remarks

The Initialize method must be called before this method can be used.

This delete does not remove any resource-specific data other than the configuration information. For instance, deleting the Product Catalog resource will not remove the Product Catalog tables from the database, just the configuration information.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' sMyResource is the name of an existing resource 
' oSiteConfig is a Commerce SiteConfig object
oSiteConfig.DeleteComponentConfig (sMyResource)

Share via