Important: To make the search of a function easier, the alphabetical search is based on the first letter following the VaToolBx prefix. For example, if you wish to find the VaToolBxWriteFile function, click W.
A
VaToolBxAddAssociation
This function is used to add the definition of an association to the list of associations read in the client configuration file.
VaToolBxAddLogicalServer
This function is used to add the definition of a logical server to the list of logical servers read in the client configuration file.
VaToolBxAddPhysicalServer
This function is used to add the definition of a physical server to the list of physical servers read in the client configuration file.
VaToolBxAPEAddInDataModel
This function is provided when using Adelia Print Engine. It is used to add data (any Adelia-type "DataValue" parameter) to a data model.
VaToolBxAPEClearDataModel
This function is provided when using Adelia Print Engine. It is used to clear a data model identified by its name.
VaToolBxAPEMergeDoc
This function is provided when using Adelia Print Engine. It is used to execute the FreeMarker template (or model) engine.
VaToolBxAPEMergeAndTransformDoc
This function is provided when using Adelia Print Engine. It is used to execute the whole APE process by executing the Merge and Transform steps in sequence.
VaToolBxAPEMergeAndTransformDocEx
This function is an extended version of VaToolBxAPEMergeAndTransformDoc. It performs the same processing plus an additional input-output parameter to retrieve information about the document produced.
VaToolBxAPETransformDoc
This function is provided when using Adelia Print Engine. It is used to execute the Apache FOP print formatter.
VaToolBxAPETransformDocEx
This function is an extended version of VaToolBxAPETransformDoc. It performs the same processing plus an additional input-output parameter to retrieve information about the document produced.
VaToolBxAddPhysicalServerEx
This function is used to add the definition of a physical server to the list of physical servers read in the client configuration file.
VaToolBxAMQPCreateExchange
This function is used to create an exchange (a message routing entity) in a message broker supporting the AMQP v0.9.1 protocol.
VaToolBxAMQPCreateQueue
This function is used to create a queue (message queue entity) in a message broker supporting the AMQP v0.9.1 protocol.
VaToolBxAMQPPublish
This function is used to publish an Adelia variable as a message to a message broker supporting the AMQP v0.9.1 protocol.
VaToolBxAMQPReleaseBroker
This function is used to release connection information to the message broker defined by the logical broker.
VaToolBxAMQPSyncPublish
This function is used to publish an Adelia variable as a message to a message broker supporting the AMQP v0.9.1 protocol.
VaToolBxAwsGetAuthType
This function is used to retrieve the name of the authentication protocol used.
VaToolBxAwsGetBrowserInfo
This function is used to retrieve information about the browser.
VaToolBxAwsGetBrowserLocale
This function is used to retrieve the (language/country) pair used by the browser.
VaToolBxAwsGetDatePattern
This function is used to retrieve the (language/country) pair used by the browser.
VaToolBxAwsGetDateSeparatorChar
This function is used to retrieve the current date separator.
VaToolBxAwsGetDecimalSeparatorChar
This function is used to retrieve the current decimal separator.
VaToolBxAwsGetGroupingSeparatorChar
This function is used to retrieve the current grouping separator.
VaToolBxAwsGetJWTClaim
This function allows to retrieve the value associated with a Claim name of a JWT token used to authenticate the user.
VaToolBxAwsGetLocale
This function is used to retrieve information on the language and country currently in use.
VaToolBxAwsGetPrefixHTTPSession
This function is used to retrieve the prefix associated with the current Web pseudo-session.
VatoolBxAwsGetPseudoSessionId
This function is used to retrieve the ID of the current Web pseudo-session.
VaToolBxAwsGetQueryString
This function gets the query string contained in the URL of the HTTP request.
VaToolBxAwsGetRealPath
This function is used to retrieve the real path from a virtual path.
This function is used to retrieve the IP address of the client which has sent the HTTP request.
This function is used to retrieve the fully qualified name of the client which has sent the HTTP request.
This function is used to retrieve the URI used by the client during the HTTP request.
This function is used to retrieve the URL from the HTTP request used by the client.
VaToolBxAwsGetSessionId
This function is used to retrieve the current HTTP session ID.
VaToolBxAwsGetTimeSeparatorChar
This function is used to retrieve the current separator used when representing a TIME variable.
This function is used to test whether the user authenticated for the current HTTP session is part of the role set as a parameter.
VaToolBxAwsSetDatePattern
This function is used to set the pattern of a date (position of day, month and year information).
VaToolBxAwsSetDateSeparatorChar
This function is used to set the date separator with the required character.
VaToolBxAwsSetDecimalSeparatorChar
This function is used to set the decimal separator with the required character.
VaToolBxAwsSetGroupingSeparatorChar
This function is used to set the grouping separator with the required character.
VaToolBxAwsSetLocale
This function is used to modify the (language/country) pair used by the browser. The country information is optional.
VaToolBxAwsSetTimeSeparatorChar
This function is used to set the separator used to represent a TIME variable with the required character.
B
VaToolBxBase64ToImage
Used to decode a base64 encoded string in an IMAGE variable.
VaToolBxBase64ImageToImage
Used to decode a base64 encoded binary in an IMAGE variable.
C
VaToolBxCanReadFile
This function is used to test if the path is a file that can be read by the program.
VaToolBxCanWriteFile
This function is used to test if the path is a file that can be written by the program.
VaToolBxCenterWindow
This function is used to center a window in the screen.
VaToolBxChooseAdeliaPrinter
This function is used to display the system dialog box used to select a printer and the print parameters (Adelia reports only).
VaToolBxChooseColor
This function is used to display the system dialog box used to select a graphical color.
VaToolBxChooseFont
This function is used to display the system dialog box used to select a character font.
VaToolBxChooseLanguage
This function is used to display the dialog box that lets you select a language.
VaToolBxChoosePrinter
This function is used to display the system dialog box used to select a printer and the print parameters (Crystal Reports reports only).
VaToolBxClearMDCLogging
In the context of trace management, this function is used to clear all contextual values from the execution thread.
VaToolBxCloseConnection
This function is used to close the connection of a logical server.
VaToolBxCloseFile
This function is used to close a text file.
VaToolBxCloudAddVFS
This function is used to add a VFS to the current context of the Adelia Cloud virtual file system.
VaToolBxCloudCheckVFSPrivilege
This function is used to test a privilege defined in a VFS. The possible privileges are those defined in the wagon.xml, i.e. read, write, UiDisplay, UiUpload, UiDownload, UiCreate, UiDelete, UiRename file.
VaToolBxCloudDownloadFile
This function is used to download a file from the server, possibly to display a preview in the browser.
VaToolBxCloudDownloadFileEx
This function is used to download a file from the server and possibly to display a preview in the browser.
VaToolBxCloudEncodeMap
This function allows to populate an array with key/value elements in order to generate a secured ID.
VaToolBxCloudGetAdeliaPrinterDefPrintMode
This function allows to retrieve the default print mode for Adelia Reports for a given printer number.
VatoolbxCloudGetAdeliaPrinterPreviewSpoolFormat
This function allows to retrieve the active format used for Adelia reports preview, for a given printer number.
VaToolBxCloudGetPrinterDefPrintMode
This function allows to retrieve the default print mode for Crystal Reports reports.
VaToolBxCloudGetReportingPoolName
This function allows to retrieve the name of the current pool used for connection to the print server.
VaToolBxCloudGetSessionAttribute
This function retrieves the value of a current cloud session attribute.
VaToolBxCloudGetSupersededAdeliaPrinterPdfAttributes
This function allows to get the names and the values of the superseded PDF attributes.
VaToolBxCloudGetUserAttribute
This function retrieves a user's private attribute value.
VaToolBxCloudGetUserAttributeObject
This function retrieves a class instance in the user's private context.
VaToolBxCloudIsUserInRole
This function tests if the user authenticated for the current Cloud session belongs to the role passed as a parameter.
VaToolBxCloudOpenURL
This function is used to open a URL either in a popup window or in an iframe inserted in the actual document.
VaToolBxCloudSetAdeliaPrinterDefPrintMode
This function allows to set the default print mode of Adelia reports for a given printer number.
VatoolbxCloudSetAdeliaPrinterPreviewSpoolFormat
This function allows to choose the format to be used for Adelia reports preview, for a given printer number.
VaToolBxCloudSetPrinterDefPrintMode
This function allows to set the default print mode for Crystal Reports reports, for a given printer number.
VaToolBxCloudSetReportingPoolName
This function allows to modify the name of the pool used for connection to the print server.
VaToolBxCloudSetSupersededAdeliaPrinterPdfAttributes
This function allows to supersede certain attributes of the produced PDF document.
VaToolBxCloudSetTaskbarDisplayMode
This function allows to define display mode for the button related to the current application in the Adelia Cloud desktop task bar.
VaToolBxCloudSetUserAttribute
This function sets a user's private attribute value. Attributes are set by security implementation.
VaToolBxCloudSetUserAttributeObject
This function sets a class instance in the user's private context.
VaToolBxCloudUpdateVFSSubstitutionVariable
This function is used to substitute a variable in the set of root paths of the Adelia Cloud virtual file system.
VaToolBxCopyFile
This function is used to copy a file to a different destination.
VaToolBxCopyFileFromJNDI
This function is used to retrieve a resource identified by a JNDI name to a local file.
VaToolBxCopyFileFromURL
This function is used to retrieve a resource identified by an URL to a local file.
VaToolBxCopyImageFromJNDI
This function is used to retrieve a resource identified by JNDI name to an IMAGE-type variable.
VaToolBxCopyImageFromURL
This function is used to retrieve a resource identified by an URL to an IMAGE-type variable.
VaToolBxCreateDirectory
This function is used to create a directory.
VaToolBxCreateFont
This function is used to create a character font that is managed as a COM interface.
VaToolBxCreatePicture
This function is used to create a picture that is managed as a COM interface.
VaToolBxCreateSessionPool
This function allows to create a pool of Middleware sessions dynamically.
VaToolBxCreateTempFile
This function is used to create a temporary file and get its name.
D
VaToolBxDecryptString
This function is used to decrypt a string using the DES cryptographic algorithm.
VaToolBxDeleteFile
This function is used to delete a file.
VaToolBxDeleteKey
This function is used to delete a key (and in some cases any associated attributes or subkeys) from the registry.
VaToolBxDeleteKeyValue
This function is used to delete an attribute and associated value for a given key in the registry.
E
VaToolBxEncryptString
This function is used to encrypt a string using the DES cryptographic algorithm.
VaToolBxEncryptAdeliaPassword
This function is used to encrypt a password using the Runtime Adelia algorithm.
VaToolBxEnumMonitors
This function enumerates the machine's active monitors.
VaToolBxEnumPrinter
This function is used to enumerate the printers installed on the current workstation.
VaToolBxEnumPrinterFontName
This function is used to enumerate the fonts of a given printer or the screen.
VaToolBxEnumPrinterFontSize
This function is used to list the font sizes of a given printer or the screen.
VaToolBxEnumPrinterPaperSize
This function is used to enumerate the paper size + associated internal value combinations for a given printer.
VaToolBxEnumPrinterPaperSource
This function is used to enumerate the printer tray + associated internal value combinations for a given printer.
VaToolBxExitProcess
This function is used to exit the current application.
VaToolBxExitWindows
This function is used to close a Windows session, shut down the system, turn off the PC or restart the system.
F
VaToolBxFBeep
This function is used to emit a beep sound.
VaToolBxFileSize
This function is used to retrieve the size of a file.
VaToolBxFileSize64
This function is used to retrieve the size of a file larger than 2 Gb.
VaToolBxFileToImage
This function is used to assign the content of a file to an IMAGE variable.
VaToolBxFindClose
This function is used to release the resources associated with a file search handle. It is used in conjunction with the VaToolBxFindNext and VaToolBxFindClose functions.
VaToolBxFindFirst
This function is used to initialize the search for the files in a directory that match a search mask. It is used in conjunction with the VaToolBxFindNext and VaToolBxFindClose functions.
VaToolBxFindNext
This function is used to resume a file search. It is used in conjunction with the VaToolBxFindFirst and VaToolBxFindClose functions.
G
VaToolBxGetAdeliaMsgId
This function is used to retrieve the internal number of an error message generated by Adelia.
VaToolBxGetAdeliaMsgJavaId
This function retrieves the internal name of an error message generated by Adelia.
VaToolBxGetAdeliaPrinterEx
This function is used to retrieve the values of print settings for Adelia reports specific to a printer number (values active for the current session).
VaToolBxGetAdeliaPrintSettings
This function is used to retrieve the values of the general settings for Adelia reports (values active for the current session).
VaToolBxGetAdeliaSpoolEncoding
This function retrieves the current encoding used for the production of spool files for Adelia reports.
VaToolBxGetClientId
Reads the current value of the text label associated with client/server connections (for use as the default value for future client/server connections).
VaToolBxGetCurrentDirectory
This function is used to retrieve the current directory.
VaToolBxGetDefaultPrinter
This function is used to retrieve the default printer name.
VaToolBxGetEnv
This function is used to retrieve the value of an environment variable.
VaToolBxGetFileCfgAdeliaPrinterEx
This function retrieves, for a given printer number, the values of print settings for Adelia reports that are stored in the wicfgva.ini configuration file.
VaToolBxGetFileCfgAdeliaPrintSettings
This function is used to retrieve the values of the general print settings for Adelia reports that are stored in the wicfgva.ini configuration file.
VaToolBxGetFileCfgClient
This function is used to retrieve the client configuration file used.
VaToolBxGetFileCfgPrinterEx
This function is used to retrieve the values of print settings for Crystal Reports reports that are stored in the wicfgvcr.ini configuration file.
VaToolBxGetFileCfgServer
This function is used to retrieve the server configuration file used.
VaToolBxGetFileTime
This function is used function is used to retrieve the date on which a file was last modified.
VaToolBxGetFileTimeEx
This function is used to get creation and last change and access dates for a file or directory.
VaToolBxGetFullPathName
This function is used to canonize a file name, i.e. get the full file name from a '..\temp\test.txt'-type relative name.
VaToolBxGetHostByIP
This function is used to retrieve a computer's name based on its IP address (IPv4 or IPv6).
VaToolBxGetLanguage
This function is used to retrieve the current language.
This function retrieves the language name according to its Windows identifier.
VaToolBxGetLastOpenedSpoolFileName
This function is used to retrieve the name (including the directory) of the last Adelia report spool file opened.
VaToolBxGetLocalIP
This function is used to retrieve the workstation's IP addresses.
VaToolBxGetMDCLogging
In the context of trace management, this function is used to retrieve the contextual value associated with a key name from the execution thread.
VaToolBxGetMiddlewareMsgFromId
This function is used to retrieve the message name corresponding to a Middleware error number.
VaToolBxGetMonitorCoordinates
This function retrieves the coordinates of the monitor or monitor workspace passed as a parameter.
VaToolBxGetMonitorFromPoint
This function retrieves the handle of the monitor containing the point whose coordinates are passed as parameters.
VaToolBxGetMonitorFromWindow
This function retrieves the handle of the monitor displaying the window passed as a parameter.
VaToolBxGetPrinterEx
This function is used to retrieve the print settings of Crystal Reports reports for a given printer number (values active for the current session).
VaToolBxGetPrinterPaperSizeText
This function is used to retrieve the text associated with the value defining a paper size for a given printer.
VaToolBxGetPrinterPaperSourceText
This function is used to retrieve the text associated with a value defining a paper tray in a given printer.
VaToolBxGetServerLanguage
This function retrieves the language for error messages in the server part.
VaToolBxGetSysColor
This function is used to retrieve the color of the display element specified in the current system configuration.
VaToolBxGetSystemLanguage
This function is used to retrieve the system language.
VaToolBxGetSystemMetrics
This function is used to retrieve the dimension (i.e. width or height, in pixels) of certain display elements and system configuration parameters.
VaToolBxGetTempDirectory
This function retrieves the name of the session's temporary directory.
VaToolBxGetUserPrivateDirectory
This function retrieves the name of the current user's private directory.
VaToolBxGetWebServiceConfigFile
This function retrieves the name and location of the configuration file used for Web service consumption.
H
VaToolBxHtmlHelp
This function enables the use of certain Microsoft HTML Help system commands. It can be used to call an entry point in an HTML help file (".chm" file).
I
VaToolBxImageToBase64
This function is used to encode a binary in a base64 string.
VaToolBxImageToBase64Ex
This function is used to encode a binary in a base64 string. It is identical to VaToolBxImageToBase64, but allows a longer output.
VaToolBxImageToBase64Image
This function is used to encode in base 64 a binary in an IMAGE variable.
VaToolBxImageToFile
This function is used to assign the content of an IMAGE variable to a file.
VaToolBxIntfMsgGetBitmapsIndex
This function is used to retrieve the index of the image associated with each error type.
VaToolBxIntfMsgGetBitmapsPosition
This function is used to retrieve the image position.
VaToolBxIntfMsgGetDisplayBitmaps
This function is used to determine whether or not an image must be displayed near a control subject to an error.
VaToolBxIntfMsgGetDlgBlinkingFrame
This function is used to retrieve the duration of a blinking period (in ms) and the number of periods.
VaToolBxIntfMsgGetDlgBlinkMode
This function is used to retrieve the management mode used for the error messages dialog box.
VaToolBxIntfMsgGetFrameBorder
This function is used to retrieve information about the frame's appearance.
VaToolBxIntfMsgGetFrameColors
This function is used to retrieve the color associated with each type of error liable to occur when the frame is drawn.
VaToolBxIntfMsgGetItgObjectsList
This function is used to retrieve the names of any graphical objects associated with the integrated error message display mode.
VaToolBxIntfMsgGetTooltipFont
This function is used to retrieve the font used for the tooltip.
VaToolBxIntfMsgGetTooltipLevel2
This function is used to retrieve the display settings for the level 2 text in the tooltip.
VaToolBxIntfMsgGetTooltipMargins
This function is used to retrieve the values of the margins relating to the tooltip.
VaToolBxIntfMsgGetTooltipMaxChars
This function is used to retrieve the maximum width of the tooltip in characters
VaToolBxIntfMsgGetTooltipPosition
This function is used to retrieve the position of the tooltip when triggered automatically upon gaining the focus.
VaToolBxIntfMsgGetTooltipSpecificColors
This function is used to retrieve the specific colors associated with the tooltip.
VaToolBxIntfMsgGetTooltipSystemColors
This function is used to determine whether or not the colors associated with the tooltip are the "system" colors.
VaToolBxIntfMsgSetBitmapsIndex
This function is used to set the index of the image associated with each error type.
VaToolBxIntfMsgSetBitmapsPosition
This function is used to set the image position.
VaToolBxIntfMsgSetDisplayBitmaps
This function is used to specify whether or not to display an image near a control subject to an error.
VaToolBxIntfMsgSetDlgBlinkingFrame
This function is used to set the duration of a blinking period (in ms) and the number of periods.
VaToolBxIntfMsgSetDlgBlinkMode
This function is used to set the management mode used for the error messages dialog box.
VaToolBxIntfMsgSetFrameBorder
This function is used to set parameters relating to the frame's appearance.
VaToolBxIntfMsgSetFrameColors
This function is used to set the color associated with each type of error liable to occur when the frame is drawn.
VaToolBxIntfMsgSetItgObjectsList
This function is used to associate graphical objects with the integrated error message display mode.
VaToolBxIntfMsgSetTooltipFont
This function is used to set the font used for the tooltip.
VaToolBxIntfMsgSetTooltipLevel2
This function is used to configure how the level 2 text is displayed in the tooltip.
VaToolBxIntfMsgSetTooltipMargins
This function is used to set the values of the margins relating to the tooltip.
VaToolBxIntfMsgSetTooltipMaxChars
This function is used to set the maximum width of the tooltip in characters.
VaToolBxIntfMsgSetTooltipPosition
This function is used to set the position of the tooltip when triggered automatically upon gaining the focus.
VaToolBxIntfMsgSetTooltipSpecificColors
This function is used to set colors specific to the tooltip. The color is only set if the system color has been disabled (see VaToolBxIntfMsgSetTooltipSystemColors).
VaToolBxIntfMsgSetTooltipSystemColors
This function is used to set the "system" colors for the tooltip.
VaToolBxIsDirectory
This function is used to test if the path provided exists and corresponds to a directory name.
VaToolBxIsFile
This function is used to test if the path provided exists and corresponds to a file name.
VaToolBxIsHidden
This function is used to test if the file or directory provided as a parameter is hidden.
VaToolBxIsPrinterValid
This function is used to test the validity of a printer resource.
VaToolBxIsProcessAlive
This function is used to check that there is a process with the specified name in the current session.
J
VaToolBxJavaDecodeURL
This function is used to decode a URL (uniform representation of special characters in characters which are specific to the specified encoding).
VaToolBxJavaEncodeURL
This function allows to encode an URL (escape special characters and spaces).
VaToolBxJavaEncodeURLComponent
This function allows to encode the value of an URL parameter (escape special characters and spaces).
VaToolBxJavaHTMLHelp
This function is used to display the contents of an HTML file in a window.
VaToolBxJavaLDAPSearch
This function lets you connect to an LDAP server in order to conduct a search according to a given context.
VaToolBxJavaQueryValue
This function is used to retrieve the value of a key (".properties" file management).
VaToolBxJavaSanitizeHTML
This function is used to sanitize an HTML code so that only certain tags or attributes are authorized and all dynamic content is removed.
VaToolBxJavaSendMail
This function is used to send an email.
VaToolBxJavaSetFileCursor
This function is used to set the mouse cursor for a particular graphical object.
VaToolBxJavaSetValue
This function is used to create or modify the value of a key (".properties" file management).
L
VaToolBxLoadBitmap
This function is used to load an IMAGE type variable with the contents of a bitmap file (".bmp" extension).
VaToolBxLogMessage
M
VaToolBxMoveFile
This function is used to move a file to a new destination. It fails if the destination file already exists.
O
VaToolBxOpenDirSelection
This function is used to call the standard directory selection window.
VaToolBxOpenFile
This function is used to open a text file.
VaToolBxOpenFileMultiSelection
This function is used to call the standard multiple file selection window.
VaToolBxOpenFileSelection
This function is used to call the standard file selection window.
P
VaToolBxPutEnv
This function is used to change the value of an environment variable.
VaToolBxPutMDCLogging
In the context of trace management, this function is used to add a contextual data to the current execution thread.
Q
VaToolBxQueryAdeliaPrinterDriverMode
This function is used to determine what type of driver (undetermined, GDI or XPS) was used for the RAW mode for a given printer number.
VaToolBxQueryAdeliaPrinterEx
This function is used to retrieve the print parameters from the standard printer selection box (Adelia reports only).
VaToolBxQueryAdeliaPrinterRawMode
This function is used to know whether RAW mode is enabled for a given printer number.
VaToolBxQueryAdeliaPrinterRawUnicode
This function is used to know whether, for a given printer number, the Unicode encoding of the print file for the RAW mode must be maintained or converted into Ascii beforehand.
VaToolBxQueryAssociation
This function is used to read the definition of an association in the client configuration file.
VaToolBxQueryConnection
This function is used to obtain the profile and password actually used after establishing a connection to a physical server.
VaToolBxQueryLanguage
This function is used to retrieve the language's name and identifier from the standard language selection box.
VaToolBxQueryPrinter
This function is used to retrieve the name and orientation of a printer from the standard printer selection box.
VaToolBxQueryPrinterEx
This function is used to retrieve the print parameters from the standard printer selection box.
VaToolBxQueryValueInt
This function is used to retrieve the integer value of the key included in the ".ini". file's section.
VaToolBxQueryValueStr
This function is used to retrieve into the Buffer parameter the string in the key included in the ".ini". file's section.
R
VaToolBxRandom
This function is used to retrieve a pseudo-random number (NUM_BIN_4).
VaToolBxReadFile
This function is used to read in a text file.
VaToolBxReadKeyValueAlpha
This function is used to read the alphanumeric value associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayBin2
This function is used to read the array value (NUM_BIN_2 format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayBin4
This function is used to read the array value (NUM_BIN_4 format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayBoolean
This function is used to read the array value (BOOL format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayDate
This function is used to read the array value (DATE format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayNum
This function is used to read the array value (NUM_E or NUM_P format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayTime
This function is used to read the array value (TIME format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueArrayTimestamp
This function is used to read the array value (TIMESTAMP format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueBin2
This function is used to read the numeric value (NUM_BIN_2 format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueBin4
This function is used to read the numeric value (NUM_BIN_4 format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueBoolean
This function is used to read the Boolean value associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueDate
This function is used to read the DATE value associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueNum
This function is used to read the numeric value (NUM_E or NUM_P format) associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueTime
This function is used to read the TIME value associated with an attribute for a given key in the registry.
VaToolBxReadKeyValueTimestamp
This function is used to read the TIMESTAMP value associated with an attribute for a given key in the registry.
VaToolBxReadString
This function is used to read a character string in a text file.
VaToolBxRegisterEvent
This function is used to register an event in the Windows events log (Application section).
VaToolBxRemoveAssociation
This function is used to delete an occurrence of an association.
VaToolBxRemoveDirectory
This function is used to remove a directory. It will fail if the specified directory is not empty.
VaToolBxRemoveLogicalServer
This function is used to delete an occurrence of a logical server.
VaToolBxRemoveMDCLogging
In the context of trace management, this function is used to remove from the execution thread the contextual value associated with a key name.
VaToolBxRemovePhysicalServer
This function is used to delete an occurrence of a physical server.
VaToolBxResetCursor
This function is used to reset the mouse cursor for a given graphical object.
VaToolBxRestoreCursor
This function is used to restore the mouse cursor for a given graphical object.
S
VaToolBxSaveBitmap
This function is used to save the contents of an IMAGE type variable containing a DIB image to a bitmap file (".bmp" extension).
VaToolBxSaveBitmapEx
This function is used to save the contents of an IMAGE type variable containing a DIB image to a Bitmap file.
VaToolBxSaveFileSelection
This function is used to call the standard file selection window.
VaToolBxSeedRand
This function is used to reset the pseudo-random number generator.
VaToolBxSendMailSMTP
This function can be used to send an email message via an SMTP server (internet).
VaToolBxSendToAvroKafka
This function is used to push an Adelia REF_CLASS-type variable or ALPHA variable to a Kafka broker, specifying a topic.
VaToolBxSendToAvroKafkaWithKey
This function is used to push an Adelia REF_CLASS-type variable or ALPHA variable to a Kafka broker, specifying a topic and a key.
VaToolBxSetAdeliaPrinter
This function is used to set permanently or for the current session the printer for the corresponding printer number (Adelia reports only).
VaToolBxSetAdeliaPrinterDriverMode
This function is used to set the type of driver to be used for the RAW mode for a given printer number.
VaToolBxSetAdeliaPrinterEx
This function is used to set permanently or for the current session the print parameters for the corresponding printer number (Adelia reports only).
VaToolBxSetAdeliaPrinterRawMode
This function is used to enable RAW mode for printing spool files in their unprocessed, or raw, form.
VaToolBxSetAdeliaPrinterRawUnicode
This function is used to force (or not force) the saving of the unicode encoding of the print file for the RAW mode for a given printer number.
VaToolBxSetAdeliaPrintSettings
This function is used to set permanently or for the current session the way spool files are managed: directory, immediate printing and deletion (Adelia reports only).
VaToolBxSetAdeliaSpoolEncoding
This function sets the encoding used for the production of spool files for Adelia reports.
VaToolBxSetClientId
This function is used to associate an identification text with client/server connections.
VaToolBxSetCurrentDirectory
This function is used to change the current directory.
VaToolBxSetDefaultPrinter
This function is used to set the default printer.
VaToolBxSetErrorMessageSilentMode
This function is used to activate/deactivate the silent mode linked to the error message display.
VaToolBxSetFileCfgClient
This function is used to define the client configuration file used.
VaToolBxSetFileCursor
This function is used to set the mouse cursor for a given graphical object.
VaToolBxSetFlagSSLPhysicalServer
This function is used to set the warning level that is activated when an SSL certificate is not valid.
VaToolBxSetFlagSSLPhysicalServerHttp
This function is used to set the warning level that is activated when an SSL certificate is not valid for a physical HTTP server.
VaToolBxSetLanguage
This function is used to set a new language for your translatable constants.
VaToolBxSetPrinter
This function is used to set permanently or for the current session the printer with an orientation for the corresponding printer number (Crystal Reports reports only).
VaToolBxSetPrinterEx
This function is used to set permanently or for the current session the print parameters for the corresponding printer number (Crystal Reports reports only).
VaToolBxSetReadOnly
This function is used to put the file in read-only mode (definition of READ_ONLY attribute).
VaToolBxSetRefWindow
This function defines a reference window for the VaToolBxCenterWindow function.
VaToolBxSetServerLanguage
This function lets you set a new language for error messages in the server part.
VaToolBxSetSystemCursor
This function is used to set the mouse cursor for a given graphical object.
VaToolBxSetTimeOut
This function is used to set the maximum time allowed for an SQL query.
VaToolBxSetTransactionalMode
This function is used to modify the transaction control mode (autocommit or manual control by COMMIT/ROLL_BACK).
VaToolBxSetValueStr
This function is used to write a string in an ".ini" file.
VaToolBxSetWebServiceConfigFile
This function sets the name and location of the configuration file to use for Web service consumption.
VaToolBxSetWritable
This function is used to put the file in read-only/write mode (deletion of READ_ONLY attribute).
This function lets you choose whether the Adelia Middleware connection dialog box is displayed or not.
VaToolBxSockClose
This function is used to close a connection.
VaToolBxSockConnectTcpServer
This function is used to connect to a TCP/IP server.
VaToolBxSockConnectTcpServerEx
This function allows you to connect to a TCP/IP server by specifying connection options.
VaToolBxSockRecvAlpha
This function is used to read alphanumeric data in the frame in a specified code (ASCII, ANSI or UNICODE).
VaToolBxSockRecvArrayByte
This function is used to read an array of bytes in the socket.
VaToolBxSockRecvArrayNumBin2
This function is used to read a two-byte binary number array in the socket by carrying out a conversion from the standard TCP/IP encoding format (Big Endian encoding).
VaToolBxSockRecvArrayNumBin4
This function is used to read an array of binary numerical data on four bytes in the socket, by performing a conversion of data from the standard TCP/IP encoding format (Big Endian code).
VaToolBxSockRecvByte
This function is used to read one byte in the socket.
VaToolBxSockRecvNumBin2
This function is used to read a two-byte binary number in the socket by carrying out a conversion from the standard TCP/IP coding format (Big Endian encoding).
VaToolBxSockRecvNumBin4
This function is used to read a four-byte binary number in the socket by carrying out a conversion from the standard TCP/IP coding format (Big Endian encoding).
VaToolBxSockSendAlpha
This function is used to write alphanumeric data in the frame in a specified code (ASCII, ANSI or UNICODE).
VaToolBxSockSendArrayByte
This function is used to write an array of bytes in the socket.
VaToolBxSockSendArrayNumBin2
This function is used to write a two-byte binary number array in the socket by carrying out a conversion into the standard TCP/IP encoding format (Big Endian encoding).
VaToolBxSockSendArrayNumBin4
This function is used to write an array of binary numerical data on four bytes in the socket, by performing a conversion of data from the standard TCP/IP encoding format (Big Endian code).
VaToolBxSockSendByte
This function is used to write one byte in the socket.
VaToolBxSockSendNumBin2
This function is used to write binary numerical data on two bytes in the socket, by performing a conversion of data from the standard TCP/IP encoding format (Big Endian code).
VaToolBxSockSendNumBin4
This function is used to write binary numerical data on four bytes in the socket, by performing a conversion of data from the standard TCP/IP encoding format (Big Endian code).
VaToolBxSockSetSoTimeout
This function defines a timeout applicable to read operations on the socket (VaToolBxSockRecvXXX functions).
U
VaToolBxUpdatePhysicalServerEx
This function is used to update the definition of a physical server in the list of physical servers read in the client configuration file.
W
VaToolBxWinHelp
This function is used to call an entry point in a help (.HLP) file.
VaToolBxWriteFile
This function is used to write a series of ASCII or ANSI data in a text file.
VaToolBxWriteKeyValueAlpha
This function is used to create an attribute and its associated alphanumeric value for a given key in the registry.
VaToolBxWriteKeyValueArrayBin2
This function is used to create an attribute and its associated array value (NUM_BIN_2 format) for a given key in the registry.
VaToolBxWriteKeyValueArrayBin4
This function is used to create an attribute and its associated array value (NUM_BIN_4 format) for a given key in the registry.
VaToolBxWriteKeyValueArrayBoolean
This function is used to create an attribute and its associated array value (BOOL format) for a given key in the registry.
VaToolBxWriteKeyValueArrayDate
This function is used to create an attribute and its associated array value (DATE format) for a given key in the registry.
VaToolBxWriteKeyValueArrayNum
This function is used to create an attribute and its associated array value (NUM_E or NUM_P format) for a given key in the registry.
VaToolBxWriteKeyValueArrayTime
This function is used to create an attribute and its associated array value (TIME format) for a given key in the registry.
VaToolBxWriteKeyValueArrayTimestamp
This function is used to create an attribute and its associated array value (TIMESTAMP format) for a given key in the registry.
VaToolBxWriteKeyValueBin2
This function is used to create an attribute and its associated numeric value (NUM_BIN_2 format) for a given key in the registry.
VaToolBxWriteKeyValueBin4
This function is used to create an attribute and its associated numeric value (NUM_BIN_4 format) for a given key in the registry.
VaToolBxWriteKeyValueBoolean
This function is used to create an attribute and its associated Boolean value for a given key in the registry.
VaToolBxWriteKeyValueDate
This function is used to create an attribute and its associated value (DATE format) for a given key in the registry.
VaToolBxWriteKeyValueNum
This function is used to create an attribute and its associated numeric value (NUM_E or NUM_P format) for a given key in the registry.
VaToolBxWriteKeyValueTime
This function is used to create an attribute and its associated numeric value (TIME format) for a given key in the registry.
VaToolBxWriteKeyValueTimestamp
This function is used to create an attribute and its associated numeric value (TIMESTAMP format) for a given key in the registry.
VaToolBxWriteString
This function is used to write a formatted character string in a text file.
VaToolBxWSGetAttachmentDirectory
This function is used to retrieve the destination directory of the attached files in the context of the REST web services production.
VaToolBxWSSetAttachmentDirectory
This function is used to set the destination directory of the attached files in the context of the REST web services production.
VaToolBxWSSetSpecificPoolName
This function is used to dynamically set the named pool used by a web service (SOAP or REST) generated with Adelia.