Fungsi GetNamedPipeInfo (namedpipeapi.h)

  • Artikel

Mengambil informasi tentang pipa bernama yang ditentukan.

Sintaks

BOOL GetNamedPipeInfo(
  [in]            HANDLE  hNamedPipe,
  [out, optional] LPDWORD lpFlags,
  [out, optional] LPDWORD lpOutBufferSize,
  [out, optional] LPDWORD lpInBufferSize,
  [out, optional] LPDWORD lpMaxInstances
);

Parameter

[in] hNamedPipe

Handel ke instans pipa bernama. Handel harus memiliki akses GENERIC_READ ke pipa bernama untuk pipa baca-saja atau baca/tulis, atau harus memiliki akses GENERIC_WRITE dan FILE_READ_ATTRIBUTES untuk pipa tulis-saja.

Parameter ini juga dapat menjadi handel ke pipa anonim, seperti yang dikembalikan oleh fungsi CreatePipe .

[out, optional] lpFlags

Penunjuk ke variabel yang menerima jenis pipa bernama. Parameter ini bisa NULL jika informasi ini tidak diperlukan. Jika tidak, parameter ini bisa menjadi satu atau beberapa nilai berikut.

Nilai Makna
PIPE_CLIENT_END
0x00000000
 Handel mengacu pada akhir klien dari instans pipa bernama. Ini adalah default.
PIPE_SERVER_END
0x00000001
 Handel mengacu pada akhir server dari instans pipa bernama. Jika nilai ini tidak ditentukan, handel mengacu pada akhir klien dari instans pipa bernama.
PIPE_TYPE_BYTE
0x00000000
 Pipa bernama adalah pipa byte. Ini adalah default.
PIPE_TYPE_MESSAGE
0x00000004
 Pipa bernama adalah pipa pesan. Jika nilai ini tidak ditentukan, pipa adalah pipa byte.

[out, optional] lpOutBufferSize

Penunjuk ke variabel yang menerima ukuran buffer untuk data keluar, dalam byte. Jika ukuran buffer nol, buffer dialokasikan sesuai kebutuhan. Parameter ini bisa NULL jika informasi ini tidak diperlukan.

[out, optional] lpInBufferSize

Penunjuk ke variabel yang menerima ukuran buffer untuk data masuk, dalam byte. Jika ukuran buffer nol, buffer dialokasikan sesuai kebutuhan. Parameter ini bisa NULL jika informasi ini tidak diperlukan.

[out, optional] lpMaxInstances

Pointer ke variabel yang menerima jumlah maksimum instans pipa yang dapat dibuat. Jika variabel diatur ke PIPE_UNLIMITED_INSTANCES (255), jumlah instans pipa yang dapat dibuat hanya dibatasi oleh ketersediaan sumber daya sistem. Parameter ini bisa NULL jika informasi ini tidak diperlukan.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Windows 10, versi 1709: Pipa hanya didukung dalam kontainer aplikasi; yaitu, dari satu proses UWP ke proses UWP lain yang merupakan bagian dari aplikasi yang sama. Selain itu, pipa bernama harus menggunakan sintaks "\\.\pipe\LOCAL\" untuk nama pipa.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows 2000 Professional [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung Windows 2000 Server [aplikasi desktop | Aplikasi UWP]
Target Platform Windows
Header namedpipeapi.h
Pustaka Kernel32.lib
DLL Kernel32.dll

Lihat juga

CreateNamedPipe

GetNamedPipeHandleState

Fungsi Pipa

Gambaran Umum Pipa