API UPnP
Gambaran umum teknologi API UPnP.
Untuk mengembangkan API UPnP, Anda memerlukan header ini:
Untuk panduan pemrograman untuk teknologi ini, lihat:
Batalkan Metode Pembatalan menghentikan operasi beban asinkron yang dimulai oleh IUPnPDescriptionDocument::LoadAsync. |
TambahkanCallback Metode AddCallback mendaftarkan panggilan balik aplikasi dengan kerangka kerja UPnP. |
AddRequestHeaders Menambahkan header HTTP yang disediakan ke permintaan HTTP. |
Menyarankan Metode Saran dipanggil oleh host perangkat untuk mulai menerima peristiwa dari layanan yang dihosting. |
AsyncOperationComplete Metode panggilan balik AsyncOperationComplete memberikan pemberitahuan tentang penyelesaian operasi I/O asinkron. |
BeginInvokeAction Metode BeginInvokeAction memanggil tindakan pada perangkat dalam mode asinkron. Selain itu, jika pengunduhan SCPD yang tertunda dan langganan peristiwa dipilih, dan belum dilakukan, metode ini akan memulai unduhan SCPD. |
BeginQueryStateVariable Metode BeginQueryStateVariable memulai permintaan asinkron untuk nilai variabel status dari layanan tertentu. |
BeginSCPDDownload Metode BeginSCPDDownload memulai pengunduhan asinkron dokumen Service Control Protocol Description (SCPD). |
BeginSubscribeToEvents BeginSubscribeToEvents memulai langganan peristiwa dalam mode asinkron dan mendaftarkan panggilan balik aplikasi dengan kerangka kerja UPnP. |
CancelAsyncFind Metode CancelAsyncFind membatalkan pencarian asinkron. |
CancelAsyncOperation Metode CancelAsyncOperation membatalkan operasi asinkron yang tertunda yang dimulai oleh metode BeginInvokeAction, BeginQueryStateVariable, BeginSubscribeToEvents, atau BeginSCPDDownload. |
CreateAsyncFind Metode CreateAsyncFind membuat operasi pencarian asinkron. |
DeviceAdded Metode DeviceAdded dipanggil oleh kerangka kerja UPnP untuk memberi tahu aplikasi bahwa perangkat telah ditambahkan ke jaringan. |
DeviceAddedWithInterface Metode DeviceAddedWithInterface dipanggil oleh kerangka kerja UPnP untuk memberi tahu aplikasi bahwa perangkat telah ditambahkan ke jaringan. |
DeviceByUDN Metode DeviceByUDN mengembalikan perangkat dengan nama perangkat unik (UDN) yang ditentukan yang terkandung dalam dokumen deskripsi yang dimuat. |
DeviceRemoved Metode DeviceRemoved dipanggil oleh kerangka kerja UPnP untuk memberi tahu aplikasi bahwa perangkat telah dihapus dari jaringan. |
EndInvokeAction Metode EndInvokeAction mengambil hasil operasi BeginInvokeAction sebelumnya dan mengambil argumen output yang dihasilkan. |
EndQueryStateVariable Metode EndQueryStateVariable mengambil hasil operasi BeginQueryStateVariable sebelumnya dan mengambil nilai variabel status khusus layanan yang dihasilkan. |
EndSCPDDownload Metode EndSCPDDownload mengambil hasil unduhan asinkron sebelumnya dari dokumen Deskripsi Protokol Kontrol Layanan (SCPD). |
EndSubscribeToEvents Metode EndSubscribeToEvents mengambil hasil operasi BeginSubscribeToEvents sebelumnya. |
FindByType Metode FindByType mencari secara sinkron untuk perangkat berdasarkan jenis perangkat atau jenis layanan. |
FindByUDN Metode FindByUDN mencari perangkat secara sinkron dengan nama perangkat uniknya (UDN). |
get__NewEnum Properti _NewEnum menentukan antarmuka enumerator IEnumVARIANT atau IEnumUnknown untuk koleksi. (IUPnPDevices.get__NewEnum) |
get__NewEnum Properti _NewEnum menentukan antarmuka enumerator IEnumVARIANT atau IEnumUnknown untuk koleksi. (IUPnPServices.get__NewEnum) |
get_Children Properti Anak menentukan semua perangkat turunan perangkat. Perangkat disimpan dalam koleksi IUPnPDevices. |
get_Count Properti Hitung menentukan jumlah perangkat dalam koleksi. |
get_Count Properti Hitung menentukan jumlah layanan dalam koleksi. |
get_Description Properti Deskripsi menentukan ringkasan fungsionalitas perangkat yang dapat dibaca manusia. |
get_FriendlyName Properti FriendlyName menentukan nama tampilan perangkat untuk perangkat. |
get_HasChildren Properti HasChildren menentukan apakah perangkat memiliki perangkat turunan. |
get_Id Properti Id menentukan ID layanan untuk layanan. |
get_IsRootDevice Properti IsRootDevice menentukan apakah perangkat adalah perangkat paling atas di pohon perangkat. |
get_Item Properti Item menentukan antarmuka IUPnPDevice untuk perangkat, yang diidentifikasi oleh UDN, dalam koleksi. |
get_Item Properti Item menentukan antarmuka IUPnPService untuk layanan, yang diidentifikasi oleh ID layanan, dalam koleksi. |
get_LastTransportStatus Untuk kueri yang terkait dengan variabel peristiwa, properti LastTransportStatus menentukan status HTTP dari operasi IUPnPService::InvokeAction terakhir. |
get_LoadResult Properti LoadResult menentukan kode keberhasilan atau kegagalan dari operasi pemuatan yang telah selesai. |
get_ManufacturerName Properti ManufacturerName menentukan bentuk yang dapat dibaca manusia dari nama produsen perangkat. |
get_ManufacturerURL Properti ManufacturerURL menentukan URL untuk situs Web produsen. |
get_ModelName Properti ModelName menentukan bentuk yang dapat dibaca manusia dari nama model perangkat. |
get_ModelNumber Properti ModelNumber menentukan bentuk yang dapat dibaca manusia dari nomor model perangkat. |
get_ModelURL Properti ModelURL menentukan URL untuk halaman Web yang berisi informasi khusus model untuk perangkat. |
get_ParentDevice Properti ParentDevice menentukan induk perangkat. |
get_PresentationURL Properti PresentationURL menentukan URL presentasi untuk halaman Web yang mengontrol perangkat. |
get_ReadyState Properti ReadyState menentukan status operasi pemuatan dokumen. |
get_RootDevice Properti RootDevice menentukan perangkat paling atas di pohon perangkat. Perangkat root mewakili objek fisik. |
get_SerialNumber Properti SerialNumber menentukan bentuk yang dapat dibaca manusia dari nomor seri perangkat. |
get_Services Properti Layanan menentukan daftar layanan yang disediakan oleh perangkat. |
get_ServiceTypeIdentifier Properti ServiceTypeIdentifier menentukan pengidentifikasi jenis layanan untuk perangkat. |
get_Type Metode Jenis menentukan pengidentifikasi sumber daya seragam (URI) jenis perangkat untuk perangkat. |
get_UniqueDeviceName Properti UniqueDeviceName menentukan nama perangkat unik (UDN) perangkat. UDN unik; tidak ada dua perangkat yang dapat memiliki UDN yang sama. |
get_UPC Properti UPC menentukan bentuk kode produk yang dapat dibaca manusia. |
GetAddressFamily Metode GetAddressFamily mengambil nilai saat ini dari bendera keluarga alamat objek Device Finder. |
GetDocument Mengambil dokumen deskripsi perangkat XML untuk perangkat UPnP. |
GetDocument Metode GetDocument mengambil dokumen Deskripsi Protokol Kontrol Layanan (SCPD) untuk objek layanan. |
GetDocumentURL Metode GetDocumentURL mengembalikan URL tempat dokumen deskripsi perangkat dapat dimuat. |
GetDocumentURL Metode GetDocumentURL mengambil URL Deskripsi Protokol Kontrol Layanan (SCPD) untuk objek layanan. Dengan menggunakan URL ini, titik kontrol UPnP dapat mengunduh dokumen SCPD lengkap. |
GetDwordValue Metode GetDwordValue mendapatkan nilai 4-byte yang menyediakan informasi tentang permintaan atau pemohon. |
GetGuidValue Metode GetGuidValue saat ini tidak didukung. |
GetServiceObject Metode GetServiceObject digunakan untuk mendapatkan pointer IDispatch ke objek layanan tertentu. Host perangkat memanggil metode ini sekali per layanan, pertama kali menerima permintaan layanan. |
GetStringValue Metode GetStringValue mendapatkan string yang menyediakan informasi tentang permintaan atau pemohon. |
GetUniqueDeviceName Metode GetUniqueDeviceName mengambil UDN untuk perangkat yang ditentukan. |
ICONURL Metode IconURL mengembalikan URL tempat ikon format yang ditentukan dapat dimuat. |
Initialize Metode Inisialisasi digunakan untuk menginisialisasi perangkat. Host perangkat memanggil metode ini. |
InvokeAction Memanggil metode pada perangkat. |
Muat Metode Muat memuat dokumen secara sinkron. Metode ini tidak mengembalikan kontrol ke pemanggil hingga operasi pemuatan selesai. |
LoadAsync Metode LoadAsync memuat dokumen secara asinkron. Metode ini segera mengembalikan kontrol ke pemanggil, dan menggunakan panggilan balik yang ditentukan untuk memberi tahu pemanggil ketika operasi selesai. |
LoadComplete Metode LoadComplete dipanggil ketika kerangka kerja UPnP telah selesai memuat deskripsi perangkat. |
OnStateChanged Metode OnStateChanged mengirimkan peristiwa ke host perangkat dengan daftar DISPID variabel status yang telah berubah. Host perangkat harus meminta objek layanan untuk mendapatkan nilai baru untuk setiap variabel status yang telah berubah. |
OnStateChangedSafe Metode OnStateChangedSafe mengirimkan peristiwa ke host perangkat dengan daftar DISPID yang telah berubah. Host perangkat harus meminta objek layanan untuk mendapatkan nilai baru untuk setiap variabel status yang telah berubah. |
QueryStateVariable Metode QueryStateVariable mengembalikan nilai variabel status layanan yang ditentukan. |
RegisterDevice Metode RegisterDevice mendaftarkan perangkat dengan host perangkat. Informasi perangkat disimpan oleh host perangkat. Kemudian, host perangkat mengembalikan pengidentifikasi perangkat dan menerbitkan dan mengumumkan perangkat di jaringan. |
RegisterDeviceProvider Metode RegisterDeviceProvider mendaftarkan penyedia perangkat dengan host perangkat. Penyedia perangkat tidak diterbitkan pada jaringan. Sebaliknya, ia membuat perangkat secara dinamis dan mendaftarkannya menggunakan RegisterRunningDevice. |
RegisterRunningDevice Metode RegisterRunningDevice mendaftarkan perangkat yang sedang berjalan dengan host perangkat. |
ReregisterDevice Metode ReregisterDevice mendaftarkan ulang perangkat dengan host perangkat. Informasi perangkat disimpan oleh host perangkat. Kemudian, host perangkat mengembalikan pengidentifikasi perangkat dan menerbitkan dan mengumumkan perangkat di jaringan. |
ReregisterRunningDevice Metode ReregisterRunningDevice mendaftarkan ulang perangkat yang sedang berjalan dengan host perangkat. |
RootDevice Metode RootDevice mengembalikan perangkat akar dari pohon perangkat dokumen yang saat ini dimuat. |
SearchComplete Metode SearchComplete dipanggil oleh kerangka kerja UPnP untuk memberi tahu aplikasi bahwa pencarian awal untuk perangkat jaringan telah selesai. |
ServiceInstanceDied Metode ServiceInstanceDied dipanggil ketika layanan tidak lagi mengirim peristiwa. |
SetAddressFamily Metode SetAddressFamily mengatur bendera keluarga alamat objek Device Finder, yang menggunakan bendera ini untuk memfilter perangkat yang ditemukan. |
SetServiceEnumProperty Metode SetServiceEnumProperty digunakan untuk menunjukkan keikutsertaan unduhan Service Control Protocol Description (SCPD) yang tertunda dan langganan peristiwa untuk objek IUPnPService yang dihitung dari objek IUPnPServices. |
Mulai Metode Mulai memulai penyedia perangkat. Host perangkat memanggil metode ini setelah memuat penyedia perangkat Metode ini melakukan inisialisasi apa pun yang diperlukan oleh penyedia perangkat. |
StartAsyncFind Metode StartAsyncFind memulai operasi pencarian asinkron. |
StateVariableChanged Metode StateVariableChanged dipanggil ketika variabel status telah berubah. |
Stop Metode Hentikan menghentikan penyedia perangkat. |
Tidak diawasi Metode Unadvise dipanggil oleh host perangkat untuk berhenti menerima peristiwa. Host perangkat melewati pointer yang sama dengan yang dilakukannya ketika memanggil metode IUPnPEventSource::Advise. |
UnregisterDevice Metode UnregisterDevice membatalkan pendaftaran perangkat dari host perangkat. Perangkat untuk sementara atau tidak terdaftar secara permanen. |
UnregisterDeviceProvider Metode UnregisterDeviceProvider secara permanen membatalkan pendaftaran dan membongkar penyedia perangkat dari host perangkat. Metode IUPnPDeviceProvider::Stop dipanggil. |
IUPnPAddressFamilyControl Antarmuka IUPnPAddressFamilyControl mengakses bendera keluarga alamat objek Device Finder. |
IUPnPAsyncResult Antarmuka IUPnPAsyncResult digunakan untuk memberi tahu titik kontrol UPnP dari operasi I/O asinkron yang telah selesai. |
IUPnPDescriptionDocument Antarmuka IUPnPDescriptionDocument memungkinkan aplikasi memuat deskripsi perangkat. |
IUPnPDescriptionDocumentCallback Antarmuka IUPnPDescriptionDocumentCallback memungkinkan kerangka kerja UPnP untuk mengomunikasikan hasil operasi beban asinkron ke aplikasi. |
IUPnPDevice Antarmuka IUPnPDevice memungkinkan aplikasi untuk mengambil informasi tentang perangkat tertentu. |
IUPnPDeviceControl Antarmuka IUPnPDeviceControl adalah titik pusat manajemen untuk perangkat dan objek layanannya. |
IUPnPDeviceDocumentAccess Antarmuka IUPnPDeviceDocumentAccess memungkinkan aplikasi untuk mendapatkan URL dokumen deskripsi perangkat. |
IUPnPDeviceDocumentAccessEx Menyediakan metode untuk mendapatkan seluruh dokumen deskripsi perangkat XML untuk perangkat tertentu. |
IUPnPDeviceFinder Antarmuka IUPnPDeviceFinder memungkinkan aplikasi menemukan perangkat. |
IUPnPDeviceFinderAddCallbackWithInterface Antarmuka IUPnPDeviceFinderAddCallbackWithInterface memungkinkan kerangka kerja UPnP untuk berkomunikasi ke aplikasi |
IUPnPDeviceFinderCallback Antarmuka IUPnPDeviceFinderCallback memungkinkan kerangka kerja UPnP untuk mengomunikasikan hasil pencarian asinkron ke aplikasi. |
IUPnPDeviceProvider Antarmuka IUPnPDeviceProvider memungkinkan penyedia perangkat untuk memulai dan menghentikan pemrosesannya. |
IUPnPDevices Antarmuka IUPnPDevices menghitung kumpulan perangkat. |
IUPnPEventSink Antarmuka IUPnPEventSink memungkinkan layanan yang dihosting untuk mengirim pemberitahuan peristiwa ke host perangkat. |
IUPnPEventSource Antarmuka IUPnPEventSource memungkinkan host perangkat mengelola langganan peristiwa untuk layanan yang dihosting. |
IUPnPHttpHeaderControl Memungkinkan penelepon untuk menentukan header HTTP tambahan yang dikirim dalam permintaan HTTP ke perangkat. |
IUPnPRegistrar Antarmuka IUPnPRegistrar mendaftarkan perangkat yang berjalan dalam konteks host perangkat. |
IUPnPRemoteEndpointInfo Antarmuka IUPnPRemoteEndpointInfo memungkinkan perangkat yang dihosting untuk mendapatkan informasi tentang pemohon (yaitu, titik kontrol) dan permintaan. |
IUPnPReregistrar Antarmuka IUPnPReregistrar memungkinkan aplikasi mendaftarkan ulang perangkat berbasis UPnP dengan host perangkat. |
IUPnPService Antarmuka IUPnPService memungkinkan aplikasi untuk mengkueri variabel status dan memanggil tindakan pada instans layanan. |
IUPnPServiceAsync Gunakan antarmuka ini untuk mengkueri variabel status secara asinkron dan memanggil tindakan pada instans layanan . |
IUPnPServiceCallback Antarmuka IUPnPServiceCallback digunakan untuk mengirim pemberitahuan peristiwa ke klien objek Layanan. |
IUPnPServiceDocumentAccess Gunakan antarmuka ini untuk mengambil dan menyediakan dokumen Deskripsi Protokol Kontrol Layanan (SCPD) ke aplikasi titik kontrol UPnP untuk mengekspos tindakan yang didukung oleh layanan dan memberikan informasi tentang variabel status. |
IUPnPServiceEnumProperty Gunakan antarmuka ini untuk menunda unduhan Service Control Protocol Description (SCPD) dan langganan peristiwa pada objek IUPnPService yang dijumlahkan dari objek IUPnPServices. |
IUPnPServices Antarmuka IUPnPServices menghitung kumpulan layanan. |