Extract an array of seven‐byte unsigned integers from this stream.

Synopsis

Declared in <bslx_byteinstream.h>

ByteInStream&
getArrayUint56(
    bsls::Types::Uint64* variables,
    int numVariables);

Description

Assign to the specified variables the consecutive seven‐byte, two's complement unsigned integers (in host byte order) comprised of each of the specified numVariables seven‐byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream. If this stream is initially invalid, this operation has no effect. If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of variables is undefined. The behavior is undefined unless 0 <= numVariables and variables has sufficient capacity. Note that each of the values will be zero‐extended.

Return Value

a reference to this stream

Parameters

Name

Description

variables

destination array for the extracted values

numVariables

number of seven‐byte unsigned integers to extract

Created with MrDocs