ICacheManager::get_AppUrl, put_AppUrl Property [CS02]
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The AppUrl property is a read/write string that contains the full URL of the application.
HRESULT ICacheManager::get_AppUrl(
BSTR* AppUrl
);
HRESULT ICacheManager::put_AppUrl(
BSTR AppUrl
);
Property AppUrl() As String
Parameters
AppUrl
[C++][in] When putting the property, a BSTR that contains the full URL of the application.[out,retval] When getting the property, a pointer to a BSTR used to return the full URL of the application.
Return Values
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
Error Values
[C++] These methods return 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 property 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.
Remarks
The default value for this property is the URL of the current Internet Information Services (IIS) 5.0 application. Depending on the URL used to access the IIS application the first time after it is started, this URL could contain the special host name "localhost," preventing it from being accessed externally. Therefore, it is best to explicitly set this property to the full URL of the IIS application.
Unlike the other properties of CacheManager object that are set on a per-cache basis, the AppUrl property is a global property. The AppUrl property is generally used to register all of the caches running in a Web server farm so that they can be managed without requiring explicit registration by an administrator.
If the cache object is a Dictionary object, then the value of this property is passed to the CacheLoader and CacheWriter objects during each cache refresh. It will be put in the _AppUrl key in the Dictionary object.