External Interfaces Reference |
Copy string mxArray
to C-style string
C Syntax
Arguments
array_ptr
Pointer to a string mxArray
; that is, a pointer to an mxArray
having the mxCHAR_CLASS
class.
buf
The starting location into which the string should be written. mxGetString
writes the character data into buf
and then terminates the string with a NULL
character (in the manner of C strings). buf
can either point to dynamic or static memory.
buflen
Maximum number of characters to read into buf
. Typically, you set buflen
to 1 plus the number of elements in the string mxArray
to which array_ptr
points. See the mxGetM
and mxGetN
reference pages to find out how to get the number of elements.
Returns
0 on success, and 1 on failure. Possible reasons for failure include:
mxArray
that is not a string mxArray
.
buflen
with less than the number of characters needed to store the entire mxArray
pointed to by array_ptr
. If this is the case, 1 is returned and the string is truncated.
Description
Call mxGetString
to copy the character data of a string mxArray
into a C-style string. The copied C-style string starts at buf
and contains no more than buflen-1
characters. The C-style string is always terminated with a NULL
character.
If the string array contains several rows, they are copied, one column at a time, into one long string array.
Examples
See revord.c
in the refbook
subdirectory of the examples
directory.
For additional examples, see explore.c
in the mex
subdirectory of the examples
directory; see mxmalloc.c
in the mx
subdirectory of the examples
directory.
See Also
mxCreateCharArray
, mxCreateCharMatrixFromStrings
, mxCreateString
mxGetScalar | mxIsCell |
© 1994-2005 The MathWorks, Inc.