[#BloombergLP-bdlt-bdexStreamIn-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::bdexStreamIn
:relfileprefix: ../../
:mrdocs:

Load into `variable` the enum value read from `stream` using BDEX&period;

== Synopsis

Declared in `&lt;bdlt&lowbar;dayofweek&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class STREAM&gt;
STREAM&
bdexStreamIn(
    STREAM& stream,
    xref:BloombergLP/bdlt/DayOfWeek/Enum.adoc[DayOfWeek::Enum]& variable,
    int version);
----

== Description

Load into the specified `variable` the `DayOfWeek&colon;&colon;Enum` value read from the specified input `stream` using the specified `version` format, and return a reference to `stream`&period; If `stream` is initially invalid, this operation has no effect&period; If `version` is not supported by `DayOfWeek`, `variable` is unaltered and `stream` is invalidated, but otherwise unmodified&period; If `version` is supported by `DayOfWeek` but `stream` becomes invalid during this operation, `variable` has an undefined, but valid, state&period; The behavior is undefined unless `STREAM` is BDEX&hyphen;compliant&period; Note that no version is read from `stream`&period; See the `bslx` package&hyphen;level documentation for more information on BDEX streaming of value&hyphen;semantic types and containers&period;

== Return Value

a reference to `stream`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| input stream providing the BDEX encoding
| *variable*
| receives the streamed enumeration value
| *version*
| BDEX format version to use
|===


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