IWMSLoggingAdmin::put_MaxSize
Previous | Next |
IWMSLoggingAdmin::put_MaxSize
The put_MaxSize method specifies the maximum permitted size of a log file.
Syntax
HRESULT put_MaxSize( long cbMaxSize );
Parameters
cbMaxSize
[in] long containing the maximum file size in kilobytes.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
Return code | Number | Description |
E_FAIL | 0x80004005 | The logging plug-in could not be found. |
E_INVALIDARG | 0x80070057 | The cbMaxSize parameter is less than or equal to zero. |
Remarks
Specifying a maximum size for a log file only applies when the log file is specifically set to cycle upon reaching its maximum size. For more information, see the IWMSLoggingAdmin::put_Cycle method.
Example Code
#include <windows.h> #include <atlbase.h> // Includes CComVariant. // To access system plug-in interfaces, the // entire type library must be imported as shown. #import "WMSServerTypeLib.dll" no_namespace named_guids \ raw_interfaces_only // Declare variables and interfaces. IWMSServer *pServer; IWMSPlugins *pPlugins; IWMSPlugin *pPlugin; IDispatch *pDispatch; IWMSLoggingAdmin *pLogAdmin; HRESULT hr; CComVariant varIndex; // Initialize the COM library and retrieve a pointer // to an IWMSServer interface. hr = CoInitialize(NULL); hr = CoCreateInstance(CLSID_WMSServer, NULL, CLSCTX_ALL, IID_IWMSServer, (void **)&pServer); if (FAILED(hr)) goto EXIT; // Retrieve a pointer to an IWMSPlugins interface // containing event handler plug-ins. hr = pServer->get_EventHandlers(&pPlugins); if (FAILED(hr)) goto EXIT; // Retrieve a pointer to the IWMSPlugin interface // of the plug-in to be configured. varIndex = "WMS Client Logging"; hr = pPlugins->get_Item(varIndex, &pPlugin); if (FAILED(hr)) goto EXIT; // Retrieve a pointer to the custom interface // of the plug-in. hr = pPlugin->get_CustomInterface(&pDispatch); if (FAILED(hr)) goto EXIT; // Query the specific administration interface // for the plug-in. hr = pDispatch->QueryInterface(IID_IWMSLoggingAdmin, (void **)&pLogAdmin); if (FAILED(hr)) goto EXIT; // Set the maximum size of a log file. hr = pLogAdmin->put_MaxSize(10000); if (FAILED(hr)) goto EXIT; EXIT: // TODO: Release temporary COM objects and uninitialize COM.
Requirements
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003 family, Windows Server 2008 family.
See Also
Previous | Next |