IWTTLog::CloseLogDevice

The CloseLogDevice method closes a log device topology that the device string or the handle specifies.

HRESULT CloseLogDevice (
  BSTR  bstrLogDeviceName,
  LONG  hDevice
);

Parameters

bstrLogDeviceName

[in] A log device string, which has the following syntax.

$<device_type>:<parameter_list>($<child_device1>[; $<child_device2>; ...])

For more information about constructing a device string, see Device String.

hDevice

[in] A handle to the device tracing topology. You can combine multiple handles by using the bitwise OR operator (for example, hDevice1 OR hDevice2).

Return Value

CloseLogDevice returns one of the following values:

  • S_OK
    The operation was successful.
  • S_FALSE
    The operation was successful but the last device has been detached, which has triggered a rollup.
  • HRESULT
    The operation failed. You should use the FAILED macro to check HRESULT values.

Comments

If a handle is specified in the hDevice parameter, the device string in the bstrLogDeviceName parameter is ignored.

Requirements

IDL: Log.IDL

Library: WTTLogCM.dll

See Also

IWTTLog Interface (COM)

Send feedback on this topic
Built on December 10, 2009