12.3.68 SP_put_encoded_string()

Synopsis

     #include <sicstus/sicstus.h>
     
     spio_t_error_code
     SP_put_encoded_string(
       SP_stream *stream,
       spio_t_wchar const *encoded_string,
       spio_t_bits options);

Write an encoded string to a text stream.

Arguments

stream

The stream. Must be a text stream open for output.

encoded_string

An encoded string to write.

options

The following bits can be set:

SP_PUT_ENCODED_STRING_OPTION_NONBLOCKING

Write the string without blocking.

Return Value

On success, all data has been written and SPIO_S_NOERR or some other success code returned.

On failure, returns an error code without transferring any data. Error codes with special meaning for SP_put_encoded_string():

SPIO_E_WOULD_BLOCK

SP_PUT_ENCODED_STRING_OPTION_NONBLOCKING was set but the operation would block.

Other error codes may also be returned.

See Also

cpg-ref-SP_put_codes. Prolog Streams.