Win32 API 日本語リファレンス
ホーム › System.DeploymentServices › IWdsTransportClient

IWdsTransportClient

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDb5dbc93a-cabe-46ca-837f-3e44e93c6545継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

WDS トランスポートサーバー上のトランスポートセッションに参加している WDS クライアントを表します。

メソッド 12

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Session(IWdsTransportSession** ppWdsTransportSession)

WDS クライアントが参加しているトランスポートセッションを受け取ります。

ppWdsTransportSessionIWdsTransportSession**outこのクライアントが参加しているセッションを表す IWdsTransportSession インターフェイスを受け取るポインタへのポインタである。
vtbl 8 HRESULT get_Id(DWORD* pulId)

WDS サーバー上でこの WDS クライアントを識別する一意のクライアント ID を受け取ります。

pulIdDWORD*outクライアントの一意な ID を受け取る変数へのポインタである。
vtbl 9 HRESULT get_Name(LPWSTR* pbszName)

WDS サーバー上の WDS クライアントの名前を受け取ります。

pbszNameLPWSTR*outクライアントの名前を受け取る文字列ポインタへのポインタである。
vtbl 10 HRESULT get_MacAddress(LPWSTR* pbszMacAddress)

WDS クライアントの MAC アドレスを受け取ります。

pbszMacAddressLPWSTR*outクライアントの MAC アドレスを受け取る文字列ポインタへのポインタである。
vtbl 11 HRESULT get_IpAddress(LPWSTR* pbszIpAddress)

WDS クライアントの IP アドレスを含む文字列値を受け取ります。

pbszIpAddressLPWSTR*outクライアントの IP アドレスを受け取る文字列ポインタへのポインタである。
vtbl 12 HRESULT get_PercentCompletion(DWORD* pulPercentCompletion)

現在のオブジェクトのうちダウンロードが完了した割合(パーセント)を受け取ります。

pulPercentCompletionDWORD*outクライアントの転送完了率(パーセント)を受け取る変数へのポインタである。
vtbl 13 HRESULT get_JoinDuration(DWORD* pulJoinDuration)

WDS クライアントがトランスポートセッションに参加してから経過した時間(秒)を受け取ります。

pulJoinDurationDWORD*outクライアントがセッションに参加してからの経過時間を受け取る変数へのポインタである。
vtbl 14 HRESULT get_CpuUtilization(DWORD* pulCpuUtilization)

WDS クライアントの CPU 使用率(パーセント)を受け取ります。

pulCpuUtilizationDWORD*outクライアントの CPU 使用率を受け取る変数へのポインタである。
vtbl 15 HRESULT get_MemoryUtilization(DWORD* pulMemoryUtilization)

WDS クライアントのメモリ使用率(パーセント)を受け取ります。

pulMemoryUtilizationDWORD*outクライアントのメモリ使用率を受け取る変数へのポインタである。
vtbl 16 HRESULT get_NetworkUtilization(DWORD* pulNetworkUtilization)

WDS クライアントが使用しているネットワーク帯域幅の割合(パーセント)を受け取ります。

pulNetworkUtilizationDWORD*outクライアントのネットワーク使用率を受け取る変数へのポインタである。
vtbl 17 HRESULT get_UserIdentity(LPWSTR* pbszUserIdentity)

このクライアントに関連付けられたユーザー ID を表す文字列を受け取ります。

pbszUserIdentityLPWSTR*outクライアントのユーザー ID 情報を受け取る文字列ポインタへのポインタである。
vtbl 18 HRESULT Disconnect(WDSTRANSPORT_DISCONNECT_TYPE DisconnectionType)

WDS クライアントをセッションから切断し、切断時にクライアントが取るべきアクションを指定します。

DisconnectionTypeWDSTRANSPORT_DISCONNECT_TYPEin切断時に WDS クライアントが取るべきアクションを指定する WDSTRANSPORT_DISCONNECT_TYPE 列挙体の値。

戻り値

標準的な HRESULT エラー値が使用されます。成功時は S_OK、失敗時はその他の値が返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IWdsTransportClient "{B5DBC93A-CABE-46CA-837F-3E44E93C6545}"
#usecom global IWdsTransportClient IID_IWdsTransportClient "{66D2C5E9-0FF6-49EC-9733-DAFB1E01DF1C}"
#comfunc global IWdsTransportClient_get_Session             7 sptr
#comfunc global IWdsTransportClient_get_Id                  8 var
#comfunc global IWdsTransportClient_get_Name                9 var
#comfunc global IWdsTransportClient_get_MacAddress          10 var
#comfunc global IWdsTransportClient_get_IpAddress           11 var
#comfunc global IWdsTransportClient_get_PercentCompletion   12 var
#comfunc global IWdsTransportClient_get_JoinDuration        13 var
#comfunc global IWdsTransportClient_get_CpuUtilization      14 var
#comfunc global IWdsTransportClient_get_MemoryUtilization   15 var
#comfunc global IWdsTransportClient_get_NetworkUtilization  16 var
#comfunc global IWdsTransportClient_get_UserIdentity        17 var
#comfunc global IWdsTransportClient_Disconnect              18 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。