IMSCSAuthManager2::UnInitialize Method
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Use this method to delete the site-specific configuration resource properties from the cache when the site is no longer valid.
HRESULT IMSCSAuthManager::UnInitialize(
BSTR bstrSiteName,
);
Sub UnInitialize(
bstrSiteName As String
)
Parameters
bstrSiteName
[C++][in] A BSTR that contains the name of the site.
[Visual Basic]
[in] A String that contains the name of the site.
Return Value
[C++] 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.
[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.
The following table shows the custom COM error that this method can return.
Constant |
Value |
Description |
---|---|---|
MSG_UPM_AUTH_SITE_NEEDED_ERROR |
[C++] 0xC1004C10 [Visual Basic] &HC1004C10 |
The Initialize method must be called with the installed site name before calling this method. |
[C++] 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] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
[C++] This method must be called to disconnect the AuthManager object cache from the specified site.
The Initialize method loads the site configuration resource properties into the cache.
This method is available when the MSCSAuthManager object is instantiated outside of the context of an ASP script.
Example
' oAuthManager is a AuthManager object.
oAuthManager.UnInitialize(sSiteName)