mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

builtin: document string.to_wide() and string_from_wide()/1

Browse Source
This commit is contained in:
Delyan Angelov 2022-11-28 09:46:04 +02:00
parent 73675dca87
commit 1d24dbe602
No known key found for this signature in database
GPG Key ID: 66886C0F12D595ED
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
vlib/builtin/utf8.c.v
View File

@ -1,9 +1,13 @@
module builtin module builtin
const ( const cp_utf8 = 65001
cp_utf8 = 65001
)
// to_wide returns a pointer to an UTF-16 version of the string receiver.
// In V, strings are encoded using UTF-8 internally, but on windows most APIs,
// that accept strings, need them to be in UTF-16 encoding.
// The returned pointer of .to_wide(), has a type of &u16, and is suitable
// for passing to Windows APIs that expect LPWSTR or wchar_t* parameters.
// See also MultiByteToWideChar ( https://learn.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-multibytetowidechar )
pub fn (_str string) to_wide() &u16 { pub fn (_str string) to_wide() &u16 {
$if windows { $if windows {
unsafe { unsafe {
@ -28,6 +32,8 @@ pub fn (_str string) to_wide() &u16 {
} }
} }
// string_from_wide creates a V string, encoded in UTF-8, given a windows
// style string encoded in UTF-16.
[unsafe] [unsafe]
pub fn string_from_wide(_wstr &u16) string { pub fn string_from_wide(_wstr &u16) string {
$if windows { $if windows {
@ -40,6 +46,10 @@ pub fn string_from_wide(_wstr &u16) string {
} }
} }
// string_from_wide2 creates a V string, encoded in UTF-8, given a windows
// style string, encoded in UTF-16. It is more efficient, compared to
// string_from_wide, but it requires you to know the input string length,
// and to pass it as the second argument.
[unsafe] [unsafe]
pub fn string_from_wide2(_wstr &u16, len int) string { pub fn string_from_wide2(_wstr &u16, len int) string {
$if windows { $if windows {