Win32 API 日本語リファレンス
ホームDevices.Tapi › ITDirectoryObjectConference

ITDirectoryObjectConference

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDf1029e5d-cb5b-11d0-8d59-00c04fd91ac0継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITDirectoryObjectConference インターフェイスは、アプリケーションが会議の詳細を設定および取得できるメソッドを提供します。ITDirectoryObjectConference インターフェイスは、ITDirectoryObject に対して QueryInterface を呼び出すことによって作成されます。

メソッド 15

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

vtbl 7 HRESULT get_Protocol(LPWSTR* ppProtocol)

get_Protocol メソッドは、プロトコル識別情報を取得します。

ppProtocolLPWSTR*outプロトコル識別子を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
ppProtocol パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

アプリケーションは、ppProtocol パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 8 HRESULT get_Originator(LPWSTR* ppOriginator)

get_Originator メソッドは、発信元のユーザー名を取得します。

ppOriginatorLPWSTR*out発信元のユーザー名を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
ppOriginator パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

アプリケーションは、ppOriginator パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

発信元の名前は、 put_MachineAddress で設定されたマシン名と合わせて会議の発信元を構成し、両方が SDP の o= 行に含まれます。

vtbl 9 HRESULT put_Originator(LPWSTR pOriginator)

put_Originator メソッドは、発信元のユーザー名を設定します。

pOriginatorLPWSTRin発信元のユーザー名を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pOriginator パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

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

発信元の名前は、 put_MachineAddress で設定されたマシン名と合わせて会議の発信元を構成し、両方が SDP の o= 行に含まれます。

vtbl 10 HRESULT get_AdvertisingScope(RND_ADVERTISING_SCOPE* pAdvertisingScope)

get_AdvertisingScope メソッドは、アドバタイズのスコープを取得します。

pAdvertisingScopeRND_ADVERTISING_SCOPE*outRND_ADVERTISING_SCOPE 列挙型へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pAdvertisingScope パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 11 HRESULT put_AdvertisingScope(RND_ADVERTISING_SCOPE AdvertisingScope)

put_AdvertisingScope メソッドは、アドバタイズのスコープを設定します。

AdvertisingScopeRND_ADVERTISING_SCOPEinRND_ADVERTISING_SCOPE 列挙型へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
AdvertisingScope パラメーターが有効ではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

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

vtbl 12 HRESULT get_Url(LPWSTR* ppUrl)

get_Url メソッドは、URL を取得します。

ppUrlLPWSTR*outURL を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
ppUrl パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

アプリケーションは、ppUrl パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 13 HRESULT put_Url(LPWSTR pUrl)

put_Url メソッドは、URL を設定します。

pUrlLPWSTRinURL を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pUrl パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

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

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

vtbl 14 HRESULT get_Description(LPWSTR* ppDescription)

get_Description メソッドは、会議の説明を取得します。

ppDescriptionLPWSTR*out会議の説明を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
ppDescription パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

アプリケーションは、ppDescription パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 15 HRESULT put_Description(LPWSTR pDescription)

put_Description メソッドは、会議の説明を設定します。

pDescriptionLPWSTRin会議の説明を格納する BSTR へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pDescription パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

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

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

vtbl 16 HRESULT get_IsEncrypted(VARIANT_BOOL* pfEncrypted)

get_IsEncrypted メソッドは、会議が暗号化されているかどうかを取得します。

pfEncryptedVARIANT_BOOL*out会議が暗号化されているかどうかへのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pfEncrypted パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 17 HRESULT put_IsEncrypted(VARIANT_BOOL fEncrypted)

put_IsEncrypted メソッドは、会議を暗号化するかどうかを設定します。

fEncryptedVARIANT_BOOLin会議を暗号化するかどうかを示すインジケーター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
fEncrypted パラメーターが有効ではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 18 HRESULT get_StartTime(DOUBLE* pDate)

get_StartTime メソッドは、会議の開始時刻を取得します。

pDateDOUBLE*out会議の開始時刻へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pDate パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 19 HRESULT put_StartTime(DOUBLE Date)

put_StartTime メソッドは、会議の開始時刻を設定します。

DateDOUBLEin会議の開始時刻。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
Date パラメーターが有効ではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 20 HRESULT get_StopTime(DOUBLE* pDate)

get_StopTime メソッドは、会議の終了時刻を取得します。終了時刻が 0 の場合、セッションに期限はありません。

pDateDOUBLE*out会議の終了時刻へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pDate パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。
vtbl 21 HRESULT put_StopTime(DOUBLE Date)

put_StopTime メソッドは、会議の終了時刻を設定します。終了時刻が 0 の場合、セッションに期限はありません。

DateDOUBLEin会議の終了時刻。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
Date パラメーターが有効ではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_FAIL
不特定のエラーです。
E_NOTIMPL
このメソッドはまだ実装されていません。

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITDirectoryObjectConference "{F1029E5D-CB5B-11D0-8D59-00C04FD91AC0}"
#usecom global ITDirectoryObjectConference IID_ITDirectoryObjectConference "{}"
#comfunc global ITDirectoryObjectConference_get_Protocol          7 var
#comfunc global ITDirectoryObjectConference_get_Originator        8 var
#comfunc global ITDirectoryObjectConference_put_Originator        9 wstr
#comfunc global ITDirectoryObjectConference_get_AdvertisingScope  10 var
#comfunc global ITDirectoryObjectConference_put_AdvertisingScope  11 int
#comfunc global ITDirectoryObjectConference_get_Url               12 var
#comfunc global ITDirectoryObjectConference_put_Url               13 wstr
#comfunc global ITDirectoryObjectConference_get_Description       14 var
#comfunc global ITDirectoryObjectConference_put_Description       15 wstr
#comfunc global ITDirectoryObjectConference_get_IsEncrypted       16 var
#comfunc global ITDirectoryObjectConference_put_IsEncrypted       17 int
#comfunc global ITDirectoryObjectConference_get_StartTime         18 var
#comfunc global ITDirectoryObjectConference_put_StartTime         19 double
#comfunc global ITDirectoryObjectConference_get_StopTime          20 var
#comfunc global ITDirectoryObjectConference_put_StopTime          21 double
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。