AuthManager.Initialize Method (PIA)

Article
11/12/2009

Use this method to initialize the AuthManager object.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop
…
Public Sub Initialize(bstrSiteName As String)

[C#]

using Microsoft.CommerceServer.Interop;
…
void Initialize(stringstrSiteName);

Parameters

[Visual Basic .NET]

bstrSiteName
A String that contains the name of the Commerce Server 2002 Web site.

[C#]

strSiteName
A string that contains the name of the Commerce Server 2002 Web site.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The AuthManager Object must be properly initialized to a valid site name immediately after creating the object and before any other AuthManager object method is used.

The first time any AuthManager object uses this method, it connects to the Administration database and caches the site configuration data using the SiteConfig object. When subsequent AuthManager objects call this method the data is read from the cache.

Use the Refresh method to update the site configuration data after any of the properties have been changed.

Use the UnInitialize method to delete the site-specific configuration resource properties from the cache when the site is no longer valid.

It is suggested that you instantiate and initialize the AuthManager object in the Global.asax file to make sure at least one instance of the object exists, and to ensure that the dynamic-link library (DLL) is loaded in memory and not flushed out by Internet Information Services (IIS) for performance reasons. This AuthManager object should not be used elsewhere. A separate instance of the AuthManager object must be created and destroyed on each ASP page.

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: mscsauthlib (in mscsauthlib.dll)