namedpipeapi.h

/******************************************************************************** * * * namedpipeapi.h - ApiSet Contract for api-ms-win-core-namedpipe-l1-1-0 * * * * Copyright (c) Microsoft Corporation. All rights reserved. * * * ********************************************************************************/

#ifdef _MSC_VER

#pragma once

#endif // _MSC_VER

#ifndef _NAMEDPIPE_H_

#define _NAMEDPIPE_H_

#include <apiset.h>

#include <apisetcconv.h>

#include <minwindef.h>

#include <minwinbase.h>

#ifdef __cplusplus

extern

"C"

{

#endif

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

CreatePipe

(

_Out_ PHANDLE hReadPipe,

PHANDLE

hReadPipe

_Out_ PHANDLE hWritePipe,

PHANDLE

hWritePipe

_In_opt_ LPSECURITY_ATTRIBUTES lpPipeAttributes,

LPSECURITY_ATTRIBUTES

lpPipeAttributes

_In_ DWORD nSize

DWORD

nSize

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

ConnectNamedPipe

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_Inout_opt_ LPOVERLAPPED lpOverlapped

LPOVERLAPPED

lpOverlapped

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

DisconnectNamedPipe

(

_In_ HANDLE hNamedPipe

HANDLE

hNamedPipe

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

SetNamedPipeHandleState

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_In_opt_ LPDWORD lpMode,

LPDWORD

lpMode

_In_opt_ LPDWORD lpMaxCollectionCount,

LPDWORD

lpMaxCollectionCount

_In_opt_ LPDWORD lpCollectDataTimeout

LPDWORD

lpCollectDataTimeout

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

PeekNamedPipe

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_Out_writes_bytes_to_opt_(nBufferSize,*lpBytesRead) LPVOID lpBuffer,

LPVOID

lpBuffer

_In_ DWORD nBufferSize,

DWORD

nBufferSize

_Out_opt_ LPDWORD lpBytesRead,

LPDWORD

lpBytesRead

_Out_opt_ LPDWORD lpTotalBytesAvail,

LPDWORD

lpTotalBytesAvail

_Out_opt_ LPDWORD lpBytesLeftThisMessage

LPDWORD

lpBytesLeftThisMessage

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

TransactNamedPipe

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_In_reads_bytes_opt_(nInBufferSize) LPVOID lpInBuffer,

LPVOID

lpInBuffer

_In_ DWORD nInBufferSize,

DWORD

nInBufferSize

_Out_writes_bytes_to_opt_(nOutBufferSize,*lpBytesRead) LPVOID lpOutBuffer,

LPVOID

lpOutBuffer

_In_ DWORD nOutBufferSize,

DWORD

nOutBufferSize

_Out_ LPDWORD lpBytesRead,

LPDWORD

lpBytesRead

_Inout_opt_ LPOVERLAPPED lpOverlapped

LPOVERLAPPED

lpOverlapped

);

WINBASEAPI

__declspec

(dllimport)

HANDLE

WINAPI

__stdcall

CreateNamedPipeW

(

_In_ LPCWSTR lpName,

LPCWSTR

lpName

_In_ DWORD dwOpenMode,

DWORD

dwOpenMode

_In_ DWORD dwPipeMode,

DWORD

dwPipeMode

_In_ DWORD nMaxInstances,

DWORD

nMaxInstances

_In_ DWORD nOutBufferSize,

DWORD

nOutBufferSize

_In_ DWORD nInBufferSize,

DWORD

nInBufferSize

_In_ DWORD nDefaultTimeOut,

DWORD

nDefaultTimeOut

_In_opt_ LPSECURITY_ATTRIBUTES lpSecurityAttributes

LPSECURITY_ATTRIBUTES

lpSecurityAttributes

);

#ifdef UNICODE

#define CreateNamedPipe CreateNamedPipeW #endif

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

WaitNamedPipeW

(

_In_ LPCWSTR lpNamedPipeName,

LPCWSTR

lpNamedPipeName

_In_ DWORD nTimeOut

DWORD

nTimeOut

);

#ifdef UNICODE

#define WaitNamedPipe WaitNamedPipeW #endif

#if (_WIN32_WINNT >= 0x0600)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

GetNamedPipeClientComputerNameW

(

_In_ HANDLE Pipe,

HANDLE

Pipe

_Out_writes_bytes_(ClientComputerNameLength) LPWSTR ClientComputerName,

LPWSTR

ClientComputerName

_In_ ULONG ClientComputerNameLength

ULONG

ClientComputerNameLength

);

#endif // (_WIN32_WINNT >= 0x0600)

#ifdef UNICODE

#define GetNamedPipeClientComputerName GetNamedPipeClientComputerNameW #endif

WINADVAPI

__declspec

(dllimport)

_Must_inspect_result_

BOOL

WINAPI

__stdcall

ImpersonateNamedPipeClient

(

_In_ HANDLE hNamedPipe

HANDLE

hNamedPipe

);

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

#pragma region Application Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

GetNamedPipeInfo

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_Out_opt_ LPDWORD lpFlags,

LPDWORD

lpFlags

_Out_opt_ LPDWORD lpOutBufferSize,

LPDWORD

lpOutBufferSize

_Out_opt_ LPDWORD lpInBufferSize,

LPDWORD

lpInBufferSize

_Out_opt_ LPDWORD lpMaxInstances

LPDWORD

lpMaxInstances

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

GetNamedPipeHandleStateW

(

_In_ HANDLE hNamedPipe,

HANDLE

hNamedPipe

_Out_opt_ LPDWORD lpState,

LPDWORD

lpState

_Out_opt_ LPDWORD lpCurInstances,

LPDWORD

lpCurInstances

_Out_opt_ LPDWORD lpMaxCollectionCount,

LPDWORD

lpMaxCollectionCount

_Out_opt_ LPDWORD lpCollectDataTimeout,

LPDWORD

lpCollectDataTimeout

_Out_writes_opt_(nMaxUserNameSize) LPWSTR lpUserName,

LPWSTR

lpUserName

_In_ DWORD nMaxUserNameSize

DWORD

nMaxUserNameSize

);

#ifdef UNICODE

#define GetNamedPipeHandleState GetNamedPipeHandleStateW #endif

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */

#pragma endregion #pragma region Application Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

CallNamedPipeW

(

_In_ LPCWSTR lpNamedPipeName,

LPCWSTR

lpNamedPipeName

_In_reads_bytes_opt_(nInBufferSize) LPVOID lpInBuffer,

LPVOID

lpInBuffer

_In_ DWORD nInBufferSize,

DWORD

nInBufferSize

_Out_writes_bytes_to_opt_(nOutBufferSize,*lpBytesRead) LPVOID lpOutBuffer,

LPVOID

lpOutBuffer

_In_ DWORD nOutBufferSize,

DWORD

nOutBufferSize

_Out_ LPDWORD lpBytesRead,

LPDWORD

lpBytesRead

_In_ DWORD nTimeOut

DWORD

nTimeOut

);

#ifdef UNICODE

#define CallNamedPipe CallNamedPipeW #endif

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */

#pragma endregion

#ifdef __cplusplus

}

#endif

#endif // _NAMEDPIPE_H_