ホーム › Devices.WebServicesOnDevices › IWSDUdpAddress
IWSDUdpAddress
COM公式ドキュメント
UDP アドレスの個々の構成要素へのアクセスを提供します。
メソッド 10
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 10 HRESULT SetSockaddr(SOCKADDR_STORAGE* pSockAddr)
ソケットアドレス情報を設定します。
| pSockAddr | SOCKADDR_STORAGE* | in | SOCKADDR_STORAGE 構造体へのポインター。 |
戻り値
戻り値には次のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは正常に完了しました。 | |
| pSockAddr が NULL です。 | |
| 操作を完了するためのメモリが不足しています。 | |
|
指定されたアドレスが有効なソケットアドレスではないか、指定されたアドレスファミリーをサポートするトランスポートプロバイダーが存在しません。 |
|
Winsock 2 DLL が初期化されていません。アプリケーションは、まず WSAStartup を呼び出して Winsock 2 を初期化する必要があります。 |
|
利用可能なバッファー領域がありません。 |
vtbl 11 HRESULT GetSockaddr(SOCKADDR_STORAGE* pSockAddr)
ソケットアドレス情報を取得します。
| pSockAddr | SOCKADDR_STORAGE* | out | アドレス情報を格納する SOCKADDR_STORAGE 構造体へのポインター。 |
戻り値
戻り値には次のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは正常に完了しました。 | |
| pSockAddr が NULL です。 | |
| メソッドが失敗しました。 |
ソケットを排他モードにするかどうかを制御します。
| fExclusive | BOOL | in | TRUE はソケットを排他モードに設定することを示します。FALSE はソケットを排他モードにしないことを示します。 |
戻り値
vtbl 13 HRESULT GetExclusive()
ソケットが排他モードかどうかを判定します。
戻り値
vtbl 14 HRESULT SetMessageType(WSDUdpMessageType messageType)
この UDP アドレス構成のメッセージタイプを設定します。
| messageType | WSDUdpMessageType | in | このアドレス構成で使用されるメッセージタイプを指定する WSDUdpMessageType 値。 |
戻り値
vtbl 15 HRESULT GetMessageType(WSDUdpMessageType* pMessageType)
この UDP アドレス構成のメッセージタイプを取得します。
| pMessageType | WSDUdpMessageType* | out | このアドレス構成で使用されるメッセージタイプを指定する WSDUdpMessageType 値へのポインター。 |
戻り値
このメソッドは次の値のいずれかを返すことがあります。
戻り値には次のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは正常に完了しました。 | |
| pMessageType が NULL です。 |
このアドレスを使用するすべての送信パケットの time-to-live (TTL) を設定します。
| dwTTL | DWORD | in | 送信 UDP パケットの TTL。一般に TTL は、パケットが破棄されるまでの最大ホップ数を表します。実装によっては TTL の解釈が異なる場合があります。 |
戻り値
戻り値には次のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| dwTTL が 255 より大きい値です。 |
このアドレスを使用するすべての送信パケットの time-to-live (TTL) を取得します。
| pdwTTL | DWORD* | out | 送信 UDP パケットの TTL へのポインター。一般に TTL は、パケットが破棄されるまでの最大ホップ数を表します。実装によっては TTL の解釈が異なる場合があります。 |
戻り値
このメソッドは次の値のいずれかを返すことがあります。
戻り値には次のものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| pdwTTL が NULL です。 |
vtbl 18 HRESULT SetAlias(GUID* pAlias)
探索(ディスカバリー)アドレスのエイリアスを設定します。
| pAlias | GUID* | in | 探索(ディスカバリー)アドレスのエイリアスへのポインター。 |
戻り値
vtbl 19 HRESULT GetAlias(GUID* pAlias)
探索(ディスカバリー)アドレスのエイリアスを取得します。
| pAlias | GUID* | out | 探索(ディスカバリー)アドレスのエイリアスへのポインター。 |
戻り値
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_IWSDUdpAddress "{74D6124A-A441-4F78-A1EB-97A8D1996893}" #usecom global IWSDUdpAddress IID_IWSDUdpAddress "{}" #comfunc global IWSDUdpAddress_SetSockaddr 10 var #comfunc global IWSDUdpAddress_GetSockaddr 11 var #comfunc global IWSDUdpAddress_SetExclusive 12 int #comfunc global IWSDUdpAddress_GetExclusive 13 #comfunc global IWSDUdpAddress_SetMessageType 14 int #comfunc global IWSDUdpAddress_GetMessageType 15 var #comfunc global IWSDUdpAddress_SetTTL 16 int #comfunc global IWSDUdpAddress_GetTTL 17 var #comfunc global IWSDUdpAddress_SetAlias 18 var #comfunc global IWSDUdpAddress_GetAlias 19 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IWSDUdpAddress "{74D6124A-A441-4F78-A1EB-97A8D1996893}" #usecom global IWSDUdpAddress IID_IWSDUdpAddress "{}" #comfunc global IWSDUdpAddress_SetSockaddr 10 sptr #comfunc global IWSDUdpAddress_GetSockaddr 11 sptr #comfunc global IWSDUdpAddress_SetExclusive 12 int #comfunc global IWSDUdpAddress_GetExclusive 13 #comfunc global IWSDUdpAddress_SetMessageType 14 int #comfunc global IWSDUdpAddress_GetMessageType 15 sptr #comfunc global IWSDUdpAddress_SetTTL 16 int #comfunc global IWSDUdpAddress_GetTTL 17 sptr #comfunc global IWSDUdpAddress_SetAlias 18 sptr #comfunc global IWSDUdpAddress_GetAlias 19 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。