ITRendezvous

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID34621d6b-6cff-11d1-aff7-00c04fc31fee継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITRendezvous インターフェイスは、Rendezvous コントロールのメインインターフェイスです。アプリケーションは、このインターフェイスに対して COM の CoCreateInstance 関数を呼び出して Rendezvous オブジェクトを作成します。

メソッド 4

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

vtbl 7 HRESULT get_DefaultDirectories(VARIANT* pVariant)

get_DefaultDirectories メソッドは、構成されているすべての既定ディレクトリを列挙します。このメソッドは EnumerateDefaultDirectories に似ていますが、Visual Basic やその他のスクリプト言語で使用するために用意されています。

pVariant

VARIANT*

out

VARIANT へのポインター。ここに ITCollection( ITDirectory インターフェイスポインターのコレクション)が返されます。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	意味
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	コレクションを作成するのに十分なメモリがありません。
E_POINTER	ポインターが無効です。

解説(Remarks)

TAPI は、ITRendezvous::get_DefaultDirectories が返す ITDirectory インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、そのインターフェイスに関連付けられたリソースを解放するために、 ITDirectory インターフェイスに対して Release を呼び出す必要があります。

vtbl 8 HRESULT EnumerateDefaultDirectories(IEnumDirectory** ppEnumDirectory)

EnumerateDefaultDirectories メソッドは、構成されているすべての既定ディレクトリを列挙します。このメソッドは get_DefaultDirectories に似ていますが、C/C++ 向けに設計されています。

ppEnumDirectory

IEnumDirectory**

out

既定ディレクトリを列挙する IEnumDirectory 列挙子を受け取るポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	意味
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	ポインターが無効です。

解説(Remarks)

TAPI は、ITRendezvous::EnumerateDefaultDirectories が返す IEnumDirectory インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、そのインターフェイスに関連付けられたリソースを解放するために、 IEnumDirectory インターフェイスに対して Release を呼び出す必要があります。

vtbl 9 HRESULT CreateDirectory(DIRECTORY_TYPE DirectoryType, LPWSTR pName, ITDirectory** ppDir)

CreateDirectory メソッドは、指定された種類と名前のディレクトリに対応する ITDirectory オブジェクトを作成します。

DirectoryType	DIRECTORY_TYPE	in	ディレクトリの種類。 DIRECTORY_TYPE を参照してください。
pName	LPWSTR	in	作成するディレクトリの名前を格納した BSTR へのポインター。
ppDir	ITDirectory**	out	上記で指定した種類の ITDirectory オブジェクトを受け取るポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	意味
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	pName または ppDir パラメーターが無効なポインターです。
E_INVALIDARG	DirectoryType パラメーターが有効ではありません。

解説(Remarks)

DT_NTDS 型のディレクトリの場合、Rendezvous はローカルのドメインコントローラー (DC) の使用のみをサポートするため、pName は無視されます。

アプリケーションは、pName パラメーターのメモリを割り当てるために SysAllocString を使用し、変数が不要になったときにメモリを解放するために SysFreeString を使用する必要があります。

TAPI は、ITRendezvous::CreateDirectory が返す ITDirectory インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、そのインターフェイスに関連付けられたリソースを解放するために、 ITDirectory インターフェイスに対して Release を呼び出す必要があります。

この関数はデータを暗号化されていない形式でネットワーク上に送信することがあるため、ネットワークを盗聴している第三者がデータを読み取れる可能性があります。このメソッドを使用する前に、データを平文で送信することのセキュリティ上のリスクを検討する必要があります。

vtbl 10 HRESULT CreateDirectoryObject(DIRECTORY_OBJECT_TYPE DirectoryObjectType, LPWSTR pName, ITDirectoryObject** ppDirectoryObject)

CreateDirectoryObject メソッドは、新しい ITDirectoryObject オブジェクトを作成します。

DirectoryObjectType	DIRECTORY_OBJECT_TYPE	in	オブジェクトの種類。 DIRECTORY_OBJECT_TYPE を参照してください。
pName	LPWSTR	in	オブジェクトの名前を格納した BSTR へのポインター。
ppDirectoryObject	ITDirectoryObject**	out	新しく作成された ITDirectoryObject オブジェクトのインターフェイスポインターを受け取るポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

値	意味
S_OK	メソッドは成功しました。
E_INVALIDARG	DirectoryObjectType パラメーターが有効ではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	ポインターが無効です。

解説(Remarks)

TAPI は、ITRendezvous::CreateDirectoryObject が返す ITDirectoryObject インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、そのインターフェイスに関連付けられたリソースを解放するために、 ITDirectoryObject インターフェイスに対して Release を呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITRendezvous "{34621D6B-6CFF-11D1-AFF7-00C04FC31FEE}"
#usecom global ITRendezvous IID_ITRendezvous "{}"
#comfunc global ITRendezvous_get_DefaultDirectories       7 var
#comfunc global ITRendezvous_EnumerateDefaultDirectories  8 sptr
#comfunc global ITRendezvous_CreateDirectory              9 int,wstr,sptr
#comfunc global ITRendezvous_CreateDirectoryObject        10 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITRendezvous "{34621D6B-6CFF-11D1-AFF7-00C04FC31FEE}"
#usecom global ITRendezvous IID_ITRendezvous "{}"
#comfunc global ITRendezvous_get_DefaultDirectories       7 sptr
#comfunc global ITRendezvous_EnumerateDefaultDirectories  8 sptr
#comfunc global ITRendezvous_CreateDirectory              9 int,wstr,sptr
#comfunc global ITRendezvous_CreateDirectoryObject        10 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。