IWMClientConnections::GetClientProperties method (wmsdkidl.h)

  • Article

[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 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

[in] dwClientNum

DWORD containing the client's index number.

[out] pClientProperties

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 code Description
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],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

IWMClientConnections Interface