Функция SetNamedPipeHandleState (namedpipeapi.h)

Задает режим чтения и режим блокировки указанного именованного канала. Если указанный дескриптор находится на стороне клиента именованного канала и серверный процесс именованного канала находится на удаленном компьютере, функцию также можно использовать для управления локальной буферизацией.

Синтаксис

BOOL SetNamedPipeHandleState(
  [in]           HANDLE  hNamedPipe,
  [in, optional] LPDWORD lpMode,
  [in, optional] LPDWORD lpMaxCollectionCount,
  [in, optional] LPDWORD lpCollectDataTimeout
);

Параметры

[in] hNamedPipe

Дескриптор экземпляра именованного канала. Этот параметр может быть дескриптором для серверного конца канала, возвращаемого функцией CreateNamedPipe , или клиентского конца канала, возвращаемого функцией CreateFile . Дескриптор должен иметь GENERIC_WRITE доступ к именованным каналу для канала, доступного только для чтения или записи, либо должен иметь доступ к GENERIC_READ и FILE_WRITE_ATTRIBUTES для канала только для чтения.

Этот параметр также может быть дескриптором для анонимного канала, возвращаемого функцией CreatePipe .

[in, optional] lpMode

Новый режим канала. Режим представляет собой сочетание флага режима чтения и флага режима ожидания. Этот параметр может иметь значение NULL , если режим не задан. Укажите один из следующих режимов.

Можно указать один из следующих режимов ожидания.

[in, optional] lpMaxCollectionCount

Максимальное число байтов, собранных на клиентском компьютере перед передачей на сервер. Этот параметр должен иметь значение NULL , если указанный дескриптор канала находится на серверной стороне именованного канала или если клиентский и серверный процессы находятся на одном компьютере. Этот параметр игнорируется, если клиентский процесс задает флаг FILE_FLAG_WRITE_THROUGH в функции CreateFile при создании дескриптора. Этот параметр может иметь значение NULL , если количество коллекций не задано.

[in, optional] lpCollectDataTimeout

Максимальное время (в миллисекундах), которое может пройти до передачи данных по сети удаленным именованным каналом. Этот параметр должен иметь значение NULL , если указанный дескриптор канала находится на сервере именованного канала или если клиентские и серверные процессы находятся на одном компьютере. Этот параметр игнорируется, если клиентский процесс указал флаг FILE_FLAG_WRITE_THROUGH в функции CreateFile при создании дескриптора. Этот параметр может иметь значение NULL , если количество коллекций не задано.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Windows 10 версии 1709: каналы поддерживаются только в контейнере приложений, т. е. от одного процесса UWP к другому процессу UWP, который является частью того же приложения. Кроме того, именованные каналы должны использовать синтаксис \\.\pipe\LOCAL\ для имени канала.

Примеры

Пример см. в разделе Клиент именованного канала.

Требования

См. также

ConnectNamedPipe

CreateFile

CreateNamedPipe

GetNamedPipeHandleState

Функции канала

Обзор каналов

ReadFile

WriteFile