Utf16FromStr - cCharTranslate

Creates a UTF-16 string in a memory buffer from an OEM, ANSI or UTF-8 String variable

Type: Function
Return Data Type: Pointer

Parameters

Parameter	Type	Description
sValue	String	DataFlex string
eCharType	Integer	The type of string encoding, which may be OEM (CP_OEMCP), ANSI (CP_ACP) or UTF-8 (CP_UTF8)
ByRef iLen	Integer	Returns the buffer's length in wide characters

Syntax

Function Utf16FromStr String sValue Integer eCharType ByRef Integer iLen Returns Pointer

Call Example

Get Utf16FromStr sValue eCharType iLen to PointerVariable

Description

Utf16FromStr creates a UTF-16 string in a memory buffer from an OEM, ANSI or UTF-8 string.

You are responsible for eventually disposing of the newly created memory buffer. This may be accomplished by using the Free function.

Use Windows.pkg
Use cCharTranslate.pkg

Object oCharTranslate is a cCharTranslate
End_Object

// test Utf16FromStr and Utf16ToStr
Procedure TestUTF16Str
    Address aUTF16Buffer
    Integer iLen iVoid
    String sVar sVar2
    Move "Test String-Ññóí" to sVar

    // Move OEM to UTF16 buffer
    Get Utf16FromStr of oCharTranslate sVar CP_OEMCP (&iLen) to aUTF16Buffer

    // Move UTF16 Buffer to OEM String
    Get Utf16ToBuffer of oCharTranslate aUTF16Buffer CP_OEMCP iLen to sVar2
    If (sVar<>sVar2) Begin
        Send Info_Box "Test Failed"
    End

    Move (Free(aUTF16Buffer)) to iVoid
End_Procedure

Send TestUTF16Str

Return Value

The buffer address, along with the buffer's length in wide characters, which is returned by reference in iLen.