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

IWdsTransportNamespace

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDfa561f57-fbef-4ed3-b056-127cb1b33b84継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

WDS トランスポートサーバー上の名前空間を表します。

メソッド 21

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

vtbl 7 HRESULT get_Type(WDSTRANSPORT_NAMESPACE_TYPE* pType)

このオブジェクトの名前空間の種類をアプリケーションが取得できるようにします。

pTypeWDSTRANSPORT_NAMESPACE_TYPE*out名前空間の種類を表す値を受け取る変数へのポインタである。
vtbl 8 HRESULT get_Id(DWORD* pulId)

サーバーに登録された名前空間の一意な名前空間 ID を受け取ります。

pulIdDWORD*out名前空間の一意な ID を受け取る変数へのポインタである。
vtbl 9 HRESULT get_Name(LPWSTR* pbszName)

名前空間の名前を設定または取得します。(Get)

pbszNameLPWSTR*out名前空間の名前を受け取る文字列ポインタへのポインタである。
vtbl 10 HRESULT put_Name(LPWSTR bszName)

名前空間の名前を設定または取得します。(Put)

bszNameLPWSTRin名前空間に設定する名前を指定する文字列である。
vtbl 11 HRESULT get_FriendlyName(LPWSTR* pbszFriendlyName)

名前空間のわかりやすい名前を設定または取得します。(Get)

pbszFriendlyNameLPWSTR*out名前空間のわかりやすい表示名を受け取る文字列ポインタへのポインタである。

解説(Remarks)

このプロパティは省略可能で、空の文字列を設定できます。

このプロパティは、現在登録されているか、過去に登録されたことのある名前空間には設定できません。

vtbl 12 HRESULT put_FriendlyName(LPWSTR bszFriendlyName)

名前空間のわかりやすい名前を設定または取得します。(Put)

bszFriendlyNameLPWSTRin名前空間に設定するわかりやすい表示名を指定する文字列である。

解説(Remarks)

このプロパティは省略可能で、空の文字列を設定できます。

このプロパティは、現在登録されているか、過去に登録されたことのある名前空間には設定できません。

vtbl 13 HRESULT get_Description(LPWSTR* pbszDescription)

名前空間の説明を設定または取得します。(Get)

pbszDescriptionLPWSTR*out名前空間の説明を受け取る文字列ポインタへのポインタである。
vtbl 14 HRESULT put_Description(LPWSTR bszDescription)

名前空間の説明を設定または取得します。(Put)

bszDescriptionLPWSTRin名前空間に設定する説明を指定する文字列である。
vtbl 15 HRESULT get_ContentProvider(LPWSTR* pbszContentProvider)

名前空間のコンテンツプロバイダーを設定または取得します。(Get)

pbszContentProviderLPWSTR*out名前空間が使用するコンテンツプロバイダーの名前を受け取る文字列ポインタへのポインタである。
vtbl 16 HRESULT put_ContentProvider(LPWSTR bszContentProvider)

名前空間のコンテンツプロバイダーを設定または取得します。(Put)

bszContentProviderLPWSTRin名前空間に設定するコンテンツプロバイダーの名前を指定する文字列である。
vtbl 17 HRESULT get_Configuration(LPWSTR* pbszConfiguration)

名前空間のコンテンツプロバイダーの構成情報を設定または取得します。(Get)

pbszConfigurationLPWSTR*out名前空間の構成情報を受け取る文字列ポインタへのポインタである。
vtbl 18 HRESULT put_Configuration(LPWSTR bszConfiguration)

名前空間のコンテンツプロバイダーの構成情報を設定または取得します。(Put)

bszConfigurationLPWSTRin名前空間に設定する構成情報を指定する文字列である。
vtbl 19 HRESULT get_Registered(VARIANT_BOOL* pbRegistered)

名前空間がサーバーに登録されているかどうかを示す値を返します。

pbRegisteredVARIANT_BOOL*out名前空間が登録済みかどうかを示すブール値を受け取る変数へのポインタである。
vtbl 20 HRESULT get_Tombstoned(VARIANT_BOOL* pbTombstoned)

登録解除された名前空間の名前空間オブジェクトを、すべてのアクティブなセッションが完了または終了するまでサーバーがメモリ上に保持しているかどうかを示す値を返します。

pbTombstonedVARIANT_BOOL*out名前空間がツームストーン状態かどうかを示すブール値を受け取る変数へのポインタである。
vtbl 21 HRESULT get_TombstoneTime(DOUBLE* pTombstoneTime)

サーバーが、登録解除された名前空間の名前空間オブジェクトを保存した UTC の日時を返します。

pTombstoneTimeDOUBLE*out名前空間がツームストーン状態になった時刻を受け取る変数へのポインタである。

解説(Remarks)

名前空間が登録解除されていない場合、このプロパティは、名前空間が現時点では有効でないことを示すエラーで失敗します。

vtbl 22 HRESULT get_TransmissionStarted(VARIANT_BOOL* pbTransmissionStarted)

この名前空間の下でサーバーがデータの送信を開始したかどうかを示す値を受け取ります。

pbTransmissionStartedVARIANT_BOOL*out送信が開始されているかどうかを示すブール値を受け取る変数へのポインタである。
vtbl 23 HRESULT Register()

名前空間をサーバーに登録します。

戻り値

標準の HRESULT エラー値が使用されます。成功の場合は S_OK、失敗の場合はその他の値です。

vtbl 24 HRESULT Deregister(VARIANT_BOOL bTerminateSessions)

名前空間をサーバーから登録解除します。

bTerminateSessionsVARIANT_BOOLinセッションを終了するかどうかを示すブール値です。

戻り値

標準の HRESULT エラー値が使用されます。成功の場合は S_OK、失敗の場合はその他の値です。

vtbl 25 HRESULT Clone(IWdsTransportNamespace** ppWdsTransportNamespaceClone)

この名前空間オブジェクトの情報を、メモリ上の新しい未登録の名前空間オブジェクトにコピーします。

ppWdsTransportNamespaceCloneIWdsTransportNamespace**outこの名前空間の新しい未登録のコピーへのインターフェイスポインターです。

戻り値

標準の HRESULT エラー値が使用されます。成功の場合は S_OK、失敗の場合はその他の値です。

vtbl 26 HRESULT Refresh()

名前空間のプロパティ値を、サーバーからの値でリセットします。

戻り値

標準の HRESULT エラー値が使用されます。成功の場合は S_OK、失敗の場合はその他の値です。

解説(Remarks)

名前空間オブジェクトがサーバーに一度も登録されていない場合、このメソッドは失敗します。

vtbl 27 HRESULT RetrieveContents(IWdsTransportCollection** ppWdsTransportContents)

名前空間に関連付けられたアクティブなトランスポートコンテンツオブジェクトのコレクションを取得します。

ppWdsTransportContentsIWdsTransportCollection**outこの名前空間の下のアクティブなセッションを表す IWdsTransportContent オブジェクトのコレクションを格納する IWdsTransportCollection オブジェクトへのポインターです。

戻り値

標準の 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_IWdsTransportNamespace "{FA561F57-FBEF-4ED3-B056-127CB1B33B84}"
#usecom global IWdsTransportNamespace IID_IWdsTransportNamespace "{D8385768-0732-4EC1-95EA-16DA581908A1}"
#comfunc global IWdsTransportNamespace_get_Type                 7 var
#comfunc global IWdsTransportNamespace_get_Id                   8 var
#comfunc global IWdsTransportNamespace_get_Name                 9 var
#comfunc global IWdsTransportNamespace_put_Name                 10 wstr
#comfunc global IWdsTransportNamespace_get_FriendlyName         11 var
#comfunc global IWdsTransportNamespace_put_FriendlyName         12 wstr
#comfunc global IWdsTransportNamespace_get_Description          13 var
#comfunc global IWdsTransportNamespace_put_Description          14 wstr
#comfunc global IWdsTransportNamespace_get_ContentProvider      15 var
#comfunc global IWdsTransportNamespace_put_ContentProvider      16 wstr
#comfunc global IWdsTransportNamespace_get_Configuration        17 var
#comfunc global IWdsTransportNamespace_put_Configuration        18 wstr
#comfunc global IWdsTransportNamespace_get_Registered           19 var
#comfunc global IWdsTransportNamespace_get_Tombstoned           20 var
#comfunc global IWdsTransportNamespace_get_TombstoneTime        21 var
#comfunc global IWdsTransportNamespace_get_TransmissionStarted  22 var
#comfunc global IWdsTransportNamespace_Register                 23
#comfunc global IWdsTransportNamespace_Deregister               24 int
#comfunc global IWdsTransportNamespace_Clone                    25 sptr
#comfunc global IWdsTransportNamespace_Refresh                  26
#comfunc global IWdsTransportNamespace_RetrieveContents         27 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。