IWMReaderAdvanced::SetClientInfo method

The SetClientInfo method sets client-side information used for logging. Use this method to specify information about the client that the reader object sends to the server for logging. If the application does not call this method, the reader object uses default values.

Syntax


HRESULT SetClientInfo(
  [in] WM_READER_CLIENTINFO *pClientInfo
);

Parameters

pClientInfo [in]

Pointer to a WM_READER_CLIENTINFO structure allocated by the caller, which contains information about the client.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

E_INVALIDARG

Invalid argument. The cbSize member must be set, and the string values must not exceed 1024 characters.

 

Remarks

Initialize the WM_READER_CLIENTINFO structure before calling this method. Always set the cbSize member equal to the size of the structure, and set any unused fields to zero.



WM_READER_CLIENTINFO info;
ZeroMemory(&info, sizeof(WM_READER_CLIENTINFO));
info.cbSize = sizeof(WM_READER_CLIENTINFO);

// Set other fields (not shown).

hr = pReaderAdvanced->SetClientInfo( &info );


Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Version

Windows Media Format 7 SDK, or later versions of the SDK

Header

Wmsdkidl.h (include Wmsdk.h)

Library

Wmvcore.lib;
WMStubDRM.lib (if you use DRM)

See also

IWMReaderAdvanced Interface
Client Logging

 

 

Show: