IWMSLoggingAdmin::put_LoggedEvents
.gif)
| Previous | Next |
IWMSLoggingAdmin::put_LoggedEvents
The put_LoggedEvents method specifies an enumeration value indicating the types of transmissions for which events are logged.
Syntax
HRESULT put_LoggedEvents( WMS_LOG_EVENT_TYPE LoggedEvents );
Parameters
LoggedEvents
[in] Member of the WMS_LOG_EVENT_TYPE enumeration type indicating the types of transmissions for which events are logged. This must be an exclusive OR of one or more of the following values.
| Value | Description |
| WMS_LOG_EVENT_DISTRIBUTION | Events are logged for a distribution server. |
| WMS_LOG_EVENT_FILTER_ON_ROLE | Events with a certain role attribute are logged |
| WMS_LOG_EVENT_LOCAL | Events are logged for local connections. |
| WMS_LOG_EVENT_NONE | Events are not logged. |
| WMS_LOG_EVENT_PLAYER | Events are logged for client connections. |
| WMS_LOG_EVENT_REMOTE | Events are logged for remote connections. |
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 LoggedEvents parameter is not a member of the WMS_LOG_EVENT_TYPE enumeration type. |
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;
// Configure the plug-in to log only events that
// fulfill certain requirements.
DWORD dwLogEvents;
dwLogEvents = WMS_LOG_EVENT_PLAYER | WMS_LOG_EVENT_LOCAL |
WMS_LOG_EVENT_FILTER_ON_ROLE;
hr = pLogAdmin->put_LoggedEvents((WMS_LOG_EVENT_TYPE)dwLogEvents);
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 |