Skip to main content
IWMClientConnections::GetClientProperties method

The GetClientProperties method retrieves information, including the IP address and protocol, about a connected client.

Syntax


HRESULT GetClientProperties(
  [in]  DWORD                dwClientNum,
  [out] WM_CLIENT_PROPERTIES *pClientProperties
);

Parameters

dwClientNum [in]

DWORD containing the client's index number.

pClientProperties [out]

Pointer to a WM_CLIENT_PROPERTIES structure.

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.

NS_E_INVALID_REQUEST

Streaming has not yet begun.

E_INVALIDARG

pcClientProperties has been passed a null value.

NS_E_INVALID_CLIENT

A client number larger than the number of clients has been passed in.

OR

Failed to get client information for unspecified reason.

 

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

IWMClientConnections Interface