IWMClientConnections2::GetClientInfo 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 GetClientInfo method retrieves information about a client attached to a writer network sink.

Syntax

HRESULT GetClientInfo(
  [in]      DWORD dwClientNum,
  [out]     WCHAR *pwszNetworkAddress,
  [in, out] DWORD *pcchNetworkAddress,
  [out]     WCHAR *pwszPort,
  [in, out] DWORD *pcchPort,
  [out]     WCHAR *pwszDNSName,
  [in, out] DWORD *pcchDNSName
);

Parameters

[in] dwClientNum

DWORD containing the client number.

[out] pwszNetworkAddress

Pointer to a wide-character null-terminated string containing the network address of the client. Pass NULL to retrieve the size of the string, which is returned in pcchNetworkAddress.

[in, out] pcchNetworkAddress

Pointer to a DWORD containing the size of pwszNetworkAddress, in wide characters. This size includes the terminating null character.

[out] pwszPort

Pointer to a wide-character null-terminated string containing the network port of the client. Pass NULL to retrieve the size of the string, which is returned in pcchPort.

[in, out] pcchPort

Pointer to a DWORD containing the size of pwszPort, in wide characters. This size includes the terminating null character.

[out] pwszDNSName

Pointer to a wide-character null-terminated string containing the name of the domain name server supporting the client. Pass NULL to retrieve the size of the string, which is returned in pcchDNSName.

[in, out] pcchDNSName

Pointer to a DWORD containing the size of pwszDNSName, in wide characters. This size includes the terminating null character.

Return value

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

Requirements

See also

IWMClientConnections2 Interface