Display the source code in std/utf.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.utf.toUTF16z`

toUTF16z is a convenience function for toUTFz!(const(wchar)*).


						
				const(wchar)* toUTF16z(C)
				(
				

				  const(C)[] str
				

				) pure @safe
				

				if (isSomeChar!C);

Encodes string s into UTF-16 and returns the encoded string. toUTF16z is suitable for calling the 'W' functions in the Win32 API that take an LPWSTR or LPCWSTR argument.

Example

string str = "Hello, World!";
const(wchar)* p = str.toUTF16z;
writeln(p[str.length]); // '\0'

Authors

Walter Bright and Jonathan M Davis

License

Boost License 1.0.