stream_set_character_format :: Quanser C Functions

navigation bar

stream_set_character_format

Determines whether the functions that send and receive t_utf8_char's, t_utf16_char's or t_utf32_char's, or arrays of them, convert between another character format when writing to or reading from the underlying communication channel.

Description

This function determines whether the functions that send and receive t_utf8_char's, t_utf16_char's or t_utf32_char's, or arrays of them, convert between another character format when writing to or reading from the underlying communication channel.

Character format conversions are only necessary when communicating between platforms that use a different character format. For example, Unix systems may use UTF-32 wide characters while Windows uses UTF-16 wide characters. By default, the character format is assumed to be the same as the local character format.

Prototype

t_error
stream_set_character_format(t_stream stream, t_stream_format format);

Parameters

t_stream stream

A stream established using stream_listen, stream_connect or stream_accept.

t_stream_format format

The character format of the peer.

Return value

Returns 0 on success. If an error occurs then a negative error code is returned.

Error codes

This function does not return any error code.

Requirements

Include Files	Libraries
quanser_stream.h	quanser_communications.lib;quanser_runtime.lib;quanser_common.lib