.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "NTFS_NLSTOUCS" "9" "09 October 2005" "" ""

.SH NAME
ntfs_nlstoucs \- convert NLS string to little endian Unicode string
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int ntfs_nlstoucs  (const ntfs_volume * \fIvol\fB, const char * \fIins\fB, const int \fIins_len\fB, ntfschar ** \fIouts\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIvol\fB\fR
ntfs volume which we are working with
.TP
\fB\fIins\fB\fR
input NLS string buffer
.TP
\fB\fIins_len\fB\fR
length of input string in bytes
.TP
\fB\fIouts\fB\fR
on return contains the allocated output Unicode string buffer
.SH "DESCRIPTION"
.PP
Convert the input string \fIins\fR, which is in whatever format the loaded NLS
map dictates, into a little endian, 2-byte Unicode string.
.PP
This function allocates the string and the caller is responsible for
calling kmem_cache_free(ntfs_name_cache, \fIouts\fR); when finished with it.
.PP
On success the function returns the number of Unicode characters written to
the output string *\fIouts\fR (>= 0), not counting the terminating Unicode NULL
character. *\fIouts\fR is set to the allocated output string buffer.
.PP
On error, a negative number corresponding to the error code is returned. In
that case the output string is not allocated. Both *\fIouts\fR and *\fIouts_len\fR
are then undefined.
.PP
This might look a bit odd due to fast path optimization...