FLI type descriptor

Summary

Converts between a Lisp string and a C wide-character string.

Syntax

:ef-wc-string &key limit external-format null-terminated-p

Arguments

limit

The maximum number of characters of the C wide-character string.

external-format

An external format specification.

null-terminated-p
A boolean controlling the null termination byte.

Description

The FLI :ef-wc-string type converts between a Lisp string and a C wide-character string. The C string may have a maximum length of limit characters. The limit can be omitted in cases where a new foreign string is being allocated.

The external-format is used to specify the encoding of the foreign string. It defaults to an encoding appropriate for C string of type wchar_t*. For Unicode encoded strings, specify :unicode. If you want to pass a string to the Windows API, known as WSTR in the Windows API terminology, also specify :unicode. To change the default, call set-locale or set-locale-encodings.

If null-terminated-p is non-nil, a NULL word is added to the end of the string.

See also

:ef-mb-string
set-locale
set-locale-encodings
Strings