Products Downloads


French version


 


This function is used to encode a string in another in base64, taking into account character encoding.


Context

  • Windows client

  • Windows server

  • Java client

  • Java server

  • Adelia Web Client

  • Adelia Cloud client

  • Event Adelia client


Parameters

ALPHA

SourceString

String to encode.

ALPHA

Encoding

Character encoding to use when converting the alphanumeric string. This encoding value must be included in the character set registry defined by the IANA. It must also be included in the character sets supported by the JVM (Java) or by the libiconv library (Windows).

If encoding is not specified (empty string), the string to encode is converted using:

  • the JVM default encoding in Java,
  • the system's current ANSI code in Windows.
ALPHA Base64String Target string, the result of the base64 encoding of the source string conversion according to the specified character encoding.

NUM_BIN_4

Length

Length of the target string.

Important: in the event of a -2 execution error, this parameter is updated when the function call is returned (see the description of the ReturnCode parameter below).

NUM_BIN_2

ReturnCode

Operation return code:

 0: Operation completed successfully.

-1: Character encoding not supported.

-2: The target string is too short. In this case, when the function is returned, the "Length" parameter is updated with the recommended string size.


For example

ALPHA(100)

str

ALPHA(1000)

strB64

ALPHA(20) encoding

NUM_BIN_4

lenStrB64

NUM_BIN_2

retCode


str = 'The pound (sign £)is the main unit of sterling'

lenStrB64 1000

encoding = 'UTF-8'

CALL_DLL 'VATOOLBX.DLL' 'VaToolBxAlphaToBase64' str encoding strB64 lenStrB64 retCode



List of VaToolBx DLL functions by topic


↑ Top of page