UPnP API
UPnP API テクノロジの概要。
UPnP API を開発するには、次のヘッダーが必要です。
このテクノロジのプログラミング ガイダンスについては、次を参照してください。
中止 Abort メソッドは、IUPnPDescriptionDocument::LoadAsync によって開始された非同期読み込み操作を停止します。 |
AddCallback AddCallback メソッドは、アプリケーションのコールバックを UPnP フレームワークに登録します。 |
AddRequestHeaders 指定された HTTP ヘッダーを HTTP 要求に追加します。 |
助言 Advise メソッドは、ホストされているサービスからのイベントの受信を開始するために、デバイス ホストによって呼び出されます。 |
AsyncOperationComplete AsyncOperationComplete コールバック メソッドは、非同期 I/O 操作の完了を通知します。 |
BeginInvokeAction BeginInvokeAction メソッドは、非同期モードでデバイス上でアクションを呼び出します。 さらに、遅延 SCPD のダウンロードとイベント サブスクリプションがオプトインされ、まだ実行されていない場合、このメソッドは SCPD ダウンロードを開始します。 |
BeginQueryStateVariable BeginQueryStateVariable メソッドは、特定のサービスから状態変数値の非同期要求を開始します。 |
BeginSCPDDownload BeginSCPDDownload メソッドは、サービス制御プロトコル記述 (SCPD) ドキュメントの非同期ダウンロードを開始します。 |
BeginSubscribeToEvents BeginSubscribeToEvents は、非同期モードでイベント サブスクリプションを開始し、アプリケーション コールバックを UPnP フレームワークに登録します。 |
CancelAsyncFind CancelAsyncFind メソッドは、非同期検索を取り消します。 |
CancelAsyncOperation CancelAsyncOperation メソッドは、BeginInvokeAction、BeginQueryStateVariable、BeginSubscribeToEvents、または BeginSCPDDownload メソッドによって開始された保留中の非同期操作を取り消します。 |
CreateAsyncFind CreateAsyncFind メソッドは、非同期検索操作を作成します。 |
DeviceAdded DeviceAdded メソッドは、デバイスがネットワークに追加されたことをアプリケーションに通知するために、UPnP フレームワークによって呼び出されます。 |
DeviceAddedWithInterface DeviceAddedWithInterface メソッドは、デバイスがネットワークに追加されたことをアプリケーションに通知するために、UPnP フレームワークによって呼び出されます。 |
DeviceByUDN DeviceByUDN メソッドは、読み込まれた説明ドキュメントに含まれる、指定された一意のデバイス名 (UDN) を持つデバイスを返します。 |
DeviceRemoved DeviceRemoved メソッドは、デバイスがネットワークから削除されたことをアプリケーションに通知するために、UPnP フレームワークによって呼び出されます。 |
EndInvokeAction EndInvokeAction メソッドは、前の BeginInvokeAction 操作の結果を取得し、結果の出力引数を取得します。 |
EndQueryStateVariable EndQueryStateVariable メソッドは、前の BeginQueryStateVariable 操作の結果を取得し、結果のサービス固有の状態変数値を取得します。 |
EndSCPDDownload EndSCPDDownload メソッドは、サービス制御プロトコル記述 (SCPD) ドキュメントの以前の非同期ダウンロードの結果を取得します。 |
EndSubscribeToEvents EndSubscribeToEvents メソッドは、前の BeginSubscribeToEvents 操作の結果を取得します。 |
FindByType FindByType メソッドは、デバイスの種類またはサービスの種類によってデバイスを同期的に検索します。 |
FindByUDN FindByUDN メソッドは、一意のデバイス名 (UDN) でデバイスを同期的に検索します。 |
get__NewEnum _NewEnum プロパティは、コレクションの IEnumVARIANT または IEnumUnknown 列挙子インターフェイスを指定します。 (IUPnPDevices.get__NewEnum) |
get__NewEnum _NewEnum プロパティは、コレクションの IEnumVARIANT または IEnumUnknown 列挙子インターフェイスを指定します。 (IUPnPServices.get__NewEnum) |
get_Children Children プロパティは、デバイスのすべての子デバイスを指定します。 デバイスは IUPnPDevices コレクションに格納されます。 |
get_Count Count プロパティは、コレクション内のデバイスの数を指定します。 |
get_Count Count プロパティは、コレクション内のサービスの数を指定します。 |
get_Description Description プロパティは、デバイスの機能の人間が判読できる概要を指定します。 |
get_FriendlyName FriendlyName プロパティは、デバイスのデバイス表示名を指定します。 |
get_HasChildren HasChildren プロパティは、デバイスに子デバイスがあるかどうかを指定します。 |
get_Id Id プロパティは、サービスのサービス ID を指定します。 |
get_IsRootDevice IsRootDevice プロパティは、デバイスがデバイス ツリーの最上位のデバイスであるかどうかを指定します。 |
get_Item Item プロパティは、UDN によって識別されるデバイスの IUPnPDevice インターフェイスをコレクション内で指定します。 |
get_Item Item プロパティは、コレクション内のサービス ID で識別されるサービスの IUPnPService インターフェイスを指定します。 |
get_LastTransportStatus イベントが発生した変数に関連するクエリの場合、LastTransportStatus プロパティは、最後の IUPnPService::InvokeAction 操作の HTTP 状態を指定します。 |
get_LoadResult LoadResult プロパティは、完了した読み込み操作の成功コードまたは失敗コードを指定します。 |
get_ManufacturerName ManufacturerName プロパティは、デバイスの製造元名の人間が判読できる形式を指定します。 |
get_ManufacturerURL ManufacturerURL プロパティは、製造元の Web サイトの URL を指定します。 |
get_ModelName ModelName プロパティは、デバイスのモデル名の人間が判読できる形式を指定します。 |
get_ModelNumber ModelNumber プロパティは、デバイスのモデル番号の人間が判読できる形式を指定します。 |
get_ModelURL ModelURL プロパティは、デバイスのモデル固有の情報を含む Web ページの URL を指定します。 |
get_ParentDevice ParentDevice プロパティは、デバイスの親を指定します。 |
get_PresentationURL PresentationURL プロパティは、デバイスを制御する Web ページのプレゼンテーション URL を指定します。 |
get_ReadyState ReadyState プロパティは、ドキュメントの読み込み操作の状態を指定します。 |
get_RootDevice RootDevice プロパティは、デバイス ツリーの最上位のデバイスを指定します。 ルート デバイスは物理オブジェクトを表します。 |
get_SerialNumber SerialNumber プロパティは、デバイスのシリアル番号の人間が判読できる形式を指定します。 |
get_Services Services プロパティは、デバイスによって提供されるサービスの一覧を指定します。 |
get_ServiceTypeIdentifier ServiceTypeIdentifier プロパティは、デバイスのサービスの種類識別子を指定します。 |
get_Type Type メソッドは、デバイスのデバイスの種類の一様リソース識別子 (URI) を指定します。 |
get_UniqueDeviceName UniqueDeviceName プロパティは、デバイスの一意のデバイス名 (UDN) を指定します。 UDN は一意です。同じ UDN を持つデバイスは 2 つもありません。 |
get_UPC UPC プロパティは、人間が判読できる形式の製品コードを指定します。 |
GetAddressFamily GetAddressFamily メソッドは、Device Finder オブジェクトのアドレス ファミリ フラグの現在の値を取得します。 |
GetDocument UPnP デバイスの XML デバイス記述ドキュメントを取得します。 |
GetDocument GetDocument メソッドは、サービス オブジェクトのサービス制御プロトコル記述 (SCPD) ドキュメントを取得します。 |
GetDocumentURL GetDocumentURL メソッドは、デバイス記述ドキュメントを読み込むことができる URL を返します。 |
GetDocumentURL GetDocumentURL メソッドは、サービス オブジェクトのサービス制御プロトコル記述 (SCPD) URL を取得します。 この URL を使用して、UPnP コントロール ポイントは完全な SCPD ドキュメントをダウンロードできます。 |
GetDwordValue GetDwordValue メソッドは、要求または要求者に関する情報を提供する 4 バイトの値を取得します。 |
GetGuidValue GetGuidValue メソッドは現在サポートされていません。 |
GetServiceObject GetServiceObject メソッドは、特定のサービス オブジェクトへの IDispatch ポインターを取得するために使用されます。 デバイス ホストは、サービスごとに 1 回、サービスの要求を初めて受信すると、このメソッドを呼び出します。 |
GetStringValue GetStringValue メソッドは、要求または要求者に関する情報を提供する文字列を取得します。 |
GetUniqueDeviceName GetUniqueDeviceName メソッドは、指定したデバイスの UDN を取得します。 |
IconURL IconURL メソッドは、指定した形式のアイコンを読み込むことができる URL を返します。 |
初期化する Initialize メソッドは、デバイスの初期化に使用されます。 デバイス ホストは、このメソッドを呼び出します。 |
InvokeAction デバイスでメソッドを呼び出します。 |
[読み込み] Load メソッドは、ドキュメントを同期的に読み込みます。 このメソッドは、読み込み操作が完了するまで呼び出し元に制御を返しません。 |
LoadAsync LoadAsync メソッドは、ドキュメントを非同期的に読み込みます。 このメソッドは、すぐに呼び出し元に制御を返し、指定されたコールバックを使用して、操作が完了したときに呼び出し元に通知します。 |
Loadcomplete LoadComplete メソッドは、UPnP フレームワークがデバイスの説明の読み込みを完了したときに呼び出されます。 |
OnStateChanged OnStateChanged メソッドは、変更された状態変数の DISPID の一覧を含むイベントをデバイス ホストに送信します。 デバイス ホストは、サービス オブジェクトに対してクエリを実行して、変更された各状態変数の新しい値を取得する必要があります。 |
OnStateChangedSafe OnStateChangedSafe メソッドは、変更された DISPID の一覧を含むイベントをデバイス ホストに送信します。 デバイス ホストは、サービス オブジェクトに対してクエリを実行して、変更された各状態変数の新しい値を取得する必要があります。 |
QueryStateVariable QueryStateVariable メソッドは、指定されたサービスの状態変数の値を返します。 |
RegisterDevice RegisterDevice メソッドは、デバイスをデバイス ホストに登録します。 デバイス情報は、デバイス ホストによって格納されます。 次に、デバイス ホストはデバイス識別子を返し、ネットワーク上のデバイスを発行して読み上げる。 |
RegisterDeviceProvider RegisterDeviceProvider メソッドは、デバイス プロバイダーをデバイス ホストに登録します。 デバイス プロバイダーがネットワーク上に公開されていません。 代わりに、デバイスを動的に作成し、RegisterRunningDevice を使用してデバイスを登録します。 |
RegisterRunningDevice RegisterRunningDevice メソッドは、実行中のデバイスをデバイス ホストに登録します。 |
ReregisterDevice ReregisterDevice メソッドは、デバイスをデバイス ホストに再登録します。 デバイス情報は、デバイス ホストによって格納されます。 次に、デバイス ホストはデバイス識別子を返し、ネットワーク上のデバイスを発行して読み上げる。 |
ReregisterRunningDevice ReregisterRunningDevice メソッドは、実行中のデバイスをデバイス ホストに再登録します。 |
RootDevice RootDevice メソッドは、現在読み込まれているドキュメントのデバイス ツリーのルート デバイスを返します。 |
SearchComplete SearchComplete メソッドは、ネットワーク デバイスの最初の検索が完了したことをアプリケーションに通知するために、UPnP フレームワークによって呼び出されます。 |
ServiceInstanceDied ServiceInstanceDied メソッドは、サービスがイベントを送信しなくなったときに呼び出されます。 |
SetAddressFamily SetAddressFamily メソッドは、Device Finder オブジェクトのアドレス ファミリ フラグを設定します。このフラグを使用して検出されたデバイスをフィルター処理します。 |
SetServiceEnumProperty SetServiceEnumProperty メソッドは、IUPnPServices オブジェクトから列挙された IUPnPService オブジェクトの遅延サービス制御プロトコル記述 (SCPD) のダウンロードとイベント サブスクリプションへのオプトインを示すために使用されます。 |
Start Start メソッドは、デバイス プロバイダーを起動します。 デバイス ホストは、デバイス プロバイダーを読み込んだ後にこのメソッドを呼び出します。このメソッドは、デバイス プロバイダーに必要なすべての初期化を実行します。 |
StartAsyncFind StartAsyncFind メソッドは、非同期検索操作を開始します。 |
StateVariableChanged StateVariableChanged メソッドは、状態変数が変更されたときに呼び出されます。 |
Stop Stop メソッドは、デバイス プロバイダーを停止します。 |
Unadvise Unadvise メソッドは、イベントの受信を停止するためにデバイス ホストによって呼び出されます。 デバイス ホストは、IUPnPEventSource::Advise メソッドを呼び出したときと同じポインターを渡します。 |
UnregisterDevice UnregisterDevice メソッドは、デバイス ホストからデバイスの登録を解除します。 デバイスは、一時的または永続的に登録解除されます。 |
UnregisterDeviceProvider UnregisterDeviceProvider メソッドは、デバイス プロバイダーを完全に登録解除し、デバイス ホストからアンロードします。 IUPnPDeviceProvider::Stop メソッドが呼び出されます。 |
IUPnPAddressFamilyControl IUPnPAddressFamilyControl インターフェイスは、Device Finder オブジェクトのアドレス ファミリ フラグにアクセスします。 |
IUPnPAsyncResult IUPnPAsyncResult インターフェイスは、完了した非同期 I/O 操作を UPnP 制御ポイントに通知するために使用されます。 |
IUPnPDescriptionDocument IUPnPDescriptionDocument インターフェイスを使用すると、アプリケーションでデバイスの説明を読み込むことができます。 |
IUPnPDescriptionDocumentCallback IUPnPDescriptionDocumentCallback インターフェイスを使用すると、UPnP フレームワークは非同期読み込み操作の結果をアプリケーションに伝達できます。 |
IUPnPDevice IUPnPDevice インターフェイスを使用すると、アプリケーションは特定のデバイスに関する情報を取得できます。 |
IUPnPDeviceControl IUPnPDeviceControl インターフェイスは、デバイスとそのサービス オブジェクトの中心的な管理ポイントです。 |
IUPnPDeviceDocumentAccess IUPnPDeviceDocumentAccess インターフェイスを使用すると、アプリケーションはデバイス記述ドキュメントの URL を取得できます。 |
IUPnPDeviceDocumentAccessEx 特定のデバイスの XML デバイス記述ドキュメント全体を取得するメソッドを提供します。 |
IUPnPDeviceFinder IUPnPDeviceFinder インターフェイスを使用すると、アプリケーションでデバイスを検索できます。 |
IUPnPDeviceFinderAddCallbackWithInterface IUPnPDeviceFinderAddCallbackWithInterface インターフェイスを使用すると、UPnP フレームワークがアプリケーションと通信できるようになります |
IUPnPDeviceFinderCallback IUPnPDeviceFinderCallback インターフェイスを使用すると、UPnP フレームワークは非同期検索の結果をアプリケーションに通信できます。 |
IUPnPDeviceProvider IUPnPDeviceProvider インターフェイスを使用すると、デバイス プロバイダーは処理を開始および停止できます。 |
IUPnPDevices IUPnPDevices インターフェイスは、デバイスのコレクションを列挙します。 |
IUPnPEventSink IUPnPEventSink インターフェイスを使用すると、ホストされたサービスがデバイス ホストにイベント通知を送信できます。 |
IUPnPEventSource IUPnPEventSource インターフェイスを使用すると、デバイス ホストはホステッド サービスのイベント サブスクリプションを管理できます。 |
IUPnPHttpHeaderControl 呼び出し元が、デバイスへの HTTP 要求で送信される追加の HTTP ヘッダーを指定できるようにします。 |
IUPnPRegistrar IUPnPRegistrar インターフェイスは、デバイス ホストのコンテキストで実行されるデバイスを登録します。 |
IUPnPRemoteEndpointInfo IUPnPRemoteEndpointInfo インターフェイスを使用すると、ホストされたデバイスは、要求元 (つまり、コントロール ポイント) と要求に関する情報を取得できます。 |
IUPnPReregistrar IUPnPReregistrar インターフェイスを使用すると、アプリケーションは UPnP ベースのデバイスをデバイス ホストに再登録できます。 |
IUPnPService IUPnPService インターフェイスを使用すると、アプリケーションは状態変数に対してクエリを実行し、サービスのインスタンスに対してアクションを呼び出すことができます。 |
IUPnPServiceAsync このインターフェイスを使用して、非同期的に状態変数のクエリを実行し、サービス のインスタンスに対してアクションを呼び出します。 |
IUPnPServiceCallback IUPnPServiceCallback インターフェイスは、Service オブジェクトのクライアントにイベント通知を送信するために使用されます。 |
IUPnPServiceDocumentAccess このインターフェイスを使用して、サービス制御プロトコル記述 (SCPD) ドキュメントを取得して UPnP コントロール ポイント アプリケーションに提供し、サービスでサポートされているアクションを公開し、状態変数に関する情報を提供します。 |
IUPnPServiceEnumProperty このインターフェイスを使用して、IUPnPServices オブジェクトから列挙された IUPnPService オブジェクトのサービス制御プロトコル記述 (SCPD) のダウンロードとイベント サブスクリプションを遅延させます。 |
IUPnPServices IUPnPServices インターフェイスは、サービスのコレクションを列挙します。 |