sh-pipe.md

title	description	keywords	topic_type	api_name	api_type	ms.topic	ms.date
sh_pipe keyword	The \ sh\_pipe\ keyword specifies the system object is a handle to a pipe.	sh_pipe keyword MIDL	apiref	sh_pipe	NA	reference	02/05/2021

sh_pipe keyword

The sh_pipe keyword specifies that a system_handle holds a handle to a pipe.

[system_handle(sh_pipe)]

[system_handle(sh_pipe, access-rights)]

Parameters

This keyword is a parameter for system_handle.

The system_handle documentation also contains details on optional use of the access-rights parameter. The default behavior is DUPLICATE_SAME_ACCESS per DuplicateHandle function specifications.

Remarks

In order to use this keyword with the system_handle attribute, the -target flag must be set to NT100 (or higher) when running midl.exe.

Examples

interface MyInterface : IUnknown                         
{         
    HRESULT GetNewPipe([out, system_handle(sh_pipe)] HANDLE* mySidePipe);

    HRESULT PutReadOnlyPipe([in, system_handle(sh_pipe, FILE_GENERIC_READ)] HANDLE theirSidePipe);
}

Requirements

Minimum supported client	Windows 10 Anniversary Update (version 1607, build 14393)
Minimum supported server	Windows Server 2016 (build 14393)

See also

system_handle

About Pipes

File Security and Access Rights

CreatePipe function

CreateNamedPipe function