SC::NamedPipeClient Struct Reference

Named pipe client endpoint creator. More...

#include <File.h>

Static Public Member Functions
static Result	connect (StringSpan name, PipeDescriptor &outConnection, NamedPipeClientOptions options={})
	Connects to an existing named pipe server endpoint.

Detailed Description

Named pipe client endpoint creator.

Member Function Documentation

connect()

static Result SC::NamedPipeClient::connect ( StringSpan name, PipeDescriptor & outConnection, NamedPipeClientOptions options = {} )

static

Connects to an existing named pipe server endpoint.

Parameters

	name	Platform-native absolute endpoint name. Use filesystem absolute paths on POSIX and \\.\pipe\... or \\?\pipe\... on Windows. See SC::NamedPipeName::build for a cross-platform helper.
[out]	outConnection	Connected read/write pipe handles.
	options	Client connection options.

Returns

Valid Result on success.

---

The documentation for this struct was generated from the following file:

• File.h