(PureBasic) Send UTF-16 on TCP or TLS Socket

See more Socket/SSL/TLS Examples

Demonstrates how to send a string on a connected TCP or SSL/TLS socket such that it is the utf-16 byte representation that is sent.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkSocket.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    tls.i = 0
    maxWaitMs.i = 20000
    domainOrIpAddr.s = "example.com"
    port.i = 1234

    ; Connect to the whatever is expecting our connection...
    success.i = CkSocket::ckConnect(socket,domainOrIpAddr,port,tls,maxWaitMs)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Let's say we have an XML file saved in the utf-16 byte representation,
    ; and we want to send it over the connection using the utf-16 byte representation...

    ; First the file into a Chilkat StringBuilder.
    ; Tell the LoadFile method that we are reading utf-16 bytes..
    sbXml.i = CkStringBuilder::ckCreate()
    If sbXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkStringBuilder::ckLoadFile(sbXml,"qa_data/xml/myUtf16.xml","utf-16")
    If success <> 1
        Debug "Failed to load utf-16 XML file.."
        CkSocket::ckDispose(socket)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; Tell the socket object that we wish to send the utf-16 byte representation of the string.
    CkSocket::setCkStringCharset(socket, "utf-16")

    ; Send the string as utf-16 bytes.
    success = CkSocket::ckSendSb(socket,sbXml)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; Let's say we wanted to instead send the string as utf-8 bytes.
    ; Just tell the socket object...
    CkSocket::setCkStringCharset(socket, "utf-8")

    ; Send the string as utf-8 bytes.
    success = CkSocket::ckSendSb(socket,sbXml)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; If our XML file was utf-8, then just tell the StringBuilder that we're reading utf-8.
    ; Once the text is properly contained in the StringBuilder, we can send the contents in any other charset (windows-1252, utf-16, utf-8, etc.) 
    ; as long as it make sense (i.e. we obviously can't send Japanese text using a single-byte charset such as Windows-1252).
    success = CkStringBuilder::ckLoadFile(sbXml,"qa_data/xml/myUtf8.xml","utf-8")
    If success <> 1
        Debug "Failed to load utf-8 XML file.."
        CkSocket::ckDispose(socket)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; Send as utf-16
    CkSocket::setCkStringCharset(socket, "utf-16")

    ; Send the string as utf-16 bytes.
    success = CkSocket::ckSendSb(socket,sbXml)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; ...
    ; ...


    CkSocket::ckDispose(socket)
    CkStringBuilder::ckDispose(sbXml)


    ProcedureReturn
EndProcedure