IWMReaderAdvanced2::SetLogClientID method (wmsdkidl.h)

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SetLogClientID method specifies whether the reader logs the client's unique ID or an anonymous session ID.

Syntax

HRESULT SetLogClientID(
  [in] BOOL fLogClientID
);

Parameters

[in] fLogClientID

Specify one of the following values:

Value Description
TRUE Send the client's unique ID.
FALSE Send an anonymous session ID.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

When the reader object streams content over the network, it sends logging data to the originating server. This logging information includes a GUID that identifies the session. By default, the reader generates an anonymous session ID. If the value of fLogClientID is TRUE, the reader sends an ID that uniquely identifies the current user. The unique ID is stored in the registry under HKEY_CURRENT_USER. If the key does not exist, the reader creates it dynamically.

Anonymous session IDs always have the following form:


3300AD50-2C39-46c0-AE0A-XXXXXXXXXXXX

where the last six bytes are randomly generated.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wmsdkidl.h (include Wmsdk.h)
Library Wmvcore.lib; WMStubDRM.lib (if you use DRM)

See also

Client Logging

IWMReaderAdvanced2 Interface

IWMReaderAdvanced2::GetLogClientID