'\" t
.\"     Title: function::user_string_utf16
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: November 2023
.\"    Manual: String and data retrieving functions Tapset
.\"    Source: SystemTap Tapset Reference
.\"  Language: English
.\"
.TH "FUNCTION::USER_STRIN" "3stap" "November 2023" "SystemTap Tapset Reference" "String and data retrieving fun"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
function::user_string_utf16 \- Retrieves UTF\-16 string from user memory
.SH "SYNOPSIS"
.sp
.nf
1) user_string_utf16:string(addr:long)
.fi
.sp
.nf
2) user_string_utf16:string(addr:long,err_msg:string)
.fi
.SH "ARGUMENTS"
.PP
\fIaddr\fR
.RS 4
The user address to retrieve the string from
.RE
.PP
\fIerr_msg\fR
.RS 4
The error message to return when data isn\*(Aqt available
.RE
.SH "DESCRIPTION"
.PP
1) This function returns a null terminated UTF\-8 string converted from the UTF\-16 string at a given user memory address\&. Reports an error on string copy fault or conversion error\&.
.PP
2) This function returns a null terminated UTF\-8 string converted from the UTF\-16 string at a given user memory address\&. Reports the given error message on string copy fault or conversion error\&.
.SH SEE ALSO\n 
.IR tapset::uconversions (3stap)