codecvt::do_out

A virtual function called to convert a sequence of internal CharTypes to a sequence of external Bytes.

virtual result do_out(
     StateType& _State,
     const CharType* _First1, 
      const CharType* _Last1,
     const CharType*& _Next1,
      Byte* _First2, 
     Byte* _Last2, 
      Byte*& _Next2
) const;

Parameters

• _State
  The conversion state that is maintained between calls to the member function.

• _First1
  Pointer to the beginning of the sequence to be converted.

• _Last1
  Pointer to the end of the sequence to be converted.

• _Next1
  Reference to a pointer to the first unconverted CharType, after the last CharType converted.

• _First2
  Pointer to the beginning of the converted sequence.

• _Last2
  Pointer to the end of the converted sequence.

• _Next2
  Reference to a pointer to the first unconverted Byte, after the last Byte converted.

Return Value

The function returns:

• codecvt_base::error if the source sequence is ill formed.

• codecvt_base::noconv if the function performs no conversion.

• codecvt_base::ok if the conversion succeeds.

• codecvt_base::partial if the source is insufficient or if the destination is not large enough for the conversion to succeed.

Remarks

_State must represent the initial conversion state at the beginning of a new source sequence. The function alters its stored value as needed to reflect the current state of a successful conversion. Its stored value is otherwise unspecified.

Example

See the example for out, which calls do_out.

Requirements

Header: <locale>

Namespace: std

See Also

Concepts

codecvt Class

codecvt Members