[#BloombergLP-balb-PipeControlChannel-start-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::xref:BloombergLP/balb/PipeControlChannel.adoc[PipeControlChannel]::start
:relfileprefix: ../../../
:mrdocs:

`start` overloads

== Synopses

Declared in `<balb_pipecontrolchannel.h>`

Open a named pipe having the specified `pipeName`, and start a thread to read messages and dispatch them to the callback specified at construction. Optionally specify `attributes` of the background processing thread. If `attributes` is not supplied, a default constructed `ThreadAttributes` object will be used. Return 0 on success, and a non‐zero value otherwise. In particular, return a non‐zero value if the pipe cannot be opened or if it is detected that another process is reading from the pipe. `pipeName` must be of the types `const char *`, `char *`, `bsl::string`, `std::string`, `std::pmr::string` (if supported), or `bslstl::StringRef`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/balb/PipeControlChannel/start-0d.adoc[start](char const* pipeName);
----

[.small]#xref:BloombergLP/balb/PipeControlChannel/start-0d.adoc[_» more..._]#

Same as the preceding overload, accepting a `STRING_TYPE` pipe name.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class STRING_TYPE>
int
xref:BloombergLP/balb/PipeControlChannel/start-0e.adoc[start](STRING_TYPE const& pipeName);
----

[.small]#xref:BloombergLP/balb/PipeControlChannel/start-0e.adoc[_» more..._]#

Same as the first overload, with the specified thread `attributes`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/balb/PipeControlChannel/start-0a.adoc[start](
    char const* pipeName,
    xref:BloombergLP/bslmt/ThreadAttributes.adoc[bslmt::ThreadAttributes] const& attributes);
----

[.small]#xref:BloombergLP/balb/PipeControlChannel/start-0a.adoc[_» more..._]#

Same as the third overload, accepting a `STRING_TYPE` pipe name.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class STRING_TYPE>
int
xref:BloombergLP/balb/PipeControlChannel/start-02.adoc[start](
    STRING_TYPE const& pipeName,
    xref:BloombergLP/bslmt/ThreadAttributes.adoc[bslmt::ThreadAttributes] const& attributes);
----

[.small]#xref:BloombergLP/balb/PipeControlChannel/start-02.adoc[_» more..._]#


[.small]#Created with https://www.mrdocs.com[MrDocs]#