convert-from-foreign-string pointer &key external-format length null-terminated-p allow-null => string
A pointer to a foreign string.
An external format specification.
The length of the string to convert.
If
t
, it is assumed the string terminates with a null character. The default value for
null-terminated-p
is
t
.
A boolean. The default is
nil
.
The function
convert-from-foreign-string
, given a pointer to a foreign string, converts the foreign string to a Lisp string. The pointer does not need to be of the correct type, as it will automatically be coerced to the correct type as specified by
external-format
.
The external-format argument is interpreted as by with-foreign-string.
Either
length
or
null-terminated-p
must be non-
nil
. If
null-terminated-p
is
t
and
length
is not specified, it is assumed that the foreign string to be converted is terminated with a null character.
If
allow-null
is non-
nil
, then if a null pointer
pointer
is passed,
nil
is returned.