Help Center
Help CenterFreeBASIC

WStrfunction

Returns a wide-character string representation of a number or ASCII character string

Converting Data Typesfunctiondocumented

Syntax

Declare Function WStr ( ByVal n As Byte ) As WString
Declare Function WStr ( ByVal n As UByte ) As WString
Declare Function WStr ( ByVal n As Short ) As WString
Declare Function WStr ( ByVal n As UShort ) As WString
Declare Function WStr ( ByVal n As Long ) As WString
Declare Function WStr ( ByVal n As ULong ) As WString
Declare Function WStr ( ByVal n As LongInt ) As WString
Declare Function WStr ( ByVal n As ULongInt ) As WString

Parameters

NameDescription
numberNumeric expression to convert to a wide-character string.
stringString expression to convert to a wide-character string.

Return value


Returns the wide-character representation of the numeric or string expression.

Description


WStr converts numeric variables to their wide-character string representation. It is the wide-character equivalent to Str.

WStr also converts ASCII character strings to Unicode character strings. If a wide-character string is given, that string is returned unmodified.

Remarks

Usage


result = WStr( number )
or
result = WStr( string )

Platform Differences


  • DOS does not support WStr.


Dialect Differences


  • Not available in the -lang qb dialect unless referenced with the alias __Wstr.

Differences from QB


  • New to FreeBASIC

See also


Example


#if defined( __FB_WIN32__ )

#include "windows.bi"

#endif



Dim zs As ZString * 20

Dim ws As WString * 20



zs = "Hello World"

ws = WStr(zs)



#if defined( __FB_WIN32__ )



MessageBox(null, ws, WStr("Unicode 'Hello World'"), MB_OK Or MB_ICONINFORMATION)



#else



Print ws

Print WStr("Unicode 'Hello World'")



#endif



Reference

  • Documented in KeyPgWstr.html