Array Functions

ArrayFileGet( filename [, null-char [, extra-alloc]] )
Converts a file to a one-dimension array.

ArrayFileGetCsv( filename, flags [, delimiter [, extra-rows [, extra-cols]]] )
Converts a CSV file to a two-dimension array.

ArrayFilePut( filename, array [, write-undef] )
Writes a one-dimension array to a file.

ArrayFilePutCsv( filename, array [, delimiter [, write-undef [, flags]] )
Writes a two-dimension array to a file.

ArrayFromStr( string )
Accepts a text string and returns a one dimension array with one character per array element.

ArrayInsert( array, sub [, dim [, value]] )
Performs in-place insertion of an element into a single dimension array, or the in-place.

Arrayize( list, delimiter )
Converts a delimited list to an array.

ArrayLocate( array, value, [sub1, [sub2, [sub3, [sub4, [sub5]]]]] )
Searches an array for an element that matches a value.

ArrayRedim( array, dim1 [, dim2 [, dim3 [, dim4 [, dim5 ] ] ] ] )
Changes array dimensions in-place.

ArrayRemove( array, sub, [ dim ] )
Performs in-place removal of an element from a single dimension array, or the in-place removal of a row or column from a two dimension array.

ArraySearch( array, value [, options [, search-column[, start-sub[, end-sub]]]] )
Searches a one or two dimension array for an element that matches a value.

ArraySort( array, [options, [sort-column, [start-sub, [end-sub]]]] )
Performs an in-place sort of arrays with one or two dimensions.

ArraySwapElements( array, subA1, subA2, subA3, subA4, subA5, subB1, subB2, subB3, subB4, subB5 )
Swaps elements in an array.

ArrDimension( dim1 [, dim2 [, dim3 [, dim4 [, dim5 ] ] ] ] )
Creates an array.

ArrayToStr( array )
Accepts a single dimension array and returns a text string constructed from the concatenation of each array element.

ArrInfo( array, request )
Gets information about an array.

ArrInitialize( array, value )
Initializes an array.

Binary Functions

BinaryAlloc( buffsize )
Allocates a memory buffer of the desired size.

BinaryCopy(handle targ, offset targ, handle src, offset src, bytecount )
Copies bytes of data from one binary buffer to another.

BinaryEodGet( handle )
Returns the offset of the free byte just after the last byte of stored data.

BinaryEodSet( handle, offset )
Sets the EOD value of a buffer.

BinaryFree( handle )
Frees a buffer previously allocated with BinaryAlloc.

BinaryIndexEx( handle, offset, string, direction, match-case )
Searches a buffer for a string. Returns a -1 if the specified string was not found.

BinaryPeek( handle, offset )
Returns the 8 bit value of a byte from a binary buffer. See BinaryPeek2, BinaryPeek4, and BinaryPeekFlt for 16 bit, 32 bit and 64 bit values.

BinaryPeekStr( handle, offset, maxsize )
Extracts a string from a binary buffer.

BinaryPoke( handle, offset, value )
Pokes a new 8 bit value into a binary buffer at offset. See BinaryPoke2, BinaryPoke4, and BinaryPokeFlt for 16 bit, 32 bit and 64 bit values.

BinaryPokeStr( handle, offset, string )
Writes a string into a binary buffer.

BinaryRead( handle, filename )
Reads a file into a binary buffer.

BinaryReplace(bin-handle, search-string, replacement-string, match-case)
Replaces strings in a binary buffer.

BinarySort( handle, recsize, key offset, key size, flags )
Sorts records in a binary buffer.

BinaryStrCnt( handle, start-offset, end-offset, string )
Counts the occurrences of a string in some or all of a binary buffer.

BinaryWrite( handle, filename )
Writes a binary buffer to a file.

dotNet

ObjectClrNew ( typename [, ctorparm,...] )
Creates a class, structure or enumeration implemented by a managed assembly. The function returns a Framework based type as a COM Automation reference that can be used to access the members of the underlying Framework based type.

ObjectClrOption ( option-name, option-value )
Sets CLR configuration options before the CLR is loaded and loads an assembly into the current WinBatch process.

ObjectClrType ( typename, value-reference )
Associate a Framework based type name with a value, or to up-cast or down-cast Framework based object references.

Disk Drive Management

DiskExist( drive letter )
Tests for the existence of a drive.

DiskFree( drive-list [, format] )
Finds the total available (unused) disk space on a group of drives.

DiskInfo ( request# )
Returns information on the specified disk drive.

DiskScan( request# )
Returns a list of drives.

DiskSize ( request# [, format] )
Finds the total size of the specified drive(s).

DiskVolInfo( root-path, request# )
Returns information on a file system volume.

File Management

ExeTypeInfo( exename )
Returns an integer describing the type of EXE file specified.

FileAppend( source-list, destination )
Appends one or more files to another file.

FileAttrGet( filename )
Returns file attributes.

FileAttrGetEx( filename )
Returns file attributes (extended).

FileAttrSet( file-list, settings )
Sets file attributes.

FileAttrSetEx( file-list, attributes, mode)
Sets file attributes (extended).

FileBaseName( filename [, flag])
Extracts the base filename from a full file path.

FileClose( filehandle )
Closes a file.

FileCompare( filename1, filename2 )
Compares two files.

FileCopy( source-list, destination, warning )
Copies files.

FileCopyAttr( source-list, destination, warning , attributes)
Copies files, and sets file attributes.

FileCreateTemp( prefix )
Creates a temporary file.

FileDelete( file-list )
Deletes files.

FileDigest( filename, algorithm, format )
Computes a message digest (hash) for a file.

FileExist( filename )
Test for the existence of files.

FileExtension( filename )
Returns the extension of a file.

FileFullName( partial filename )
Returns a file name with drive and path information.

FileGet( filename [, null-char])
Converts a file to a string variable.

FileGetW( filename [, null-char])
Converts a file to a Unicode string variable.

FileInfoToArray( file-list [, flags])
Returns information on a set of files, as an array.

FileItemize( file-list )
Builds a list of files.

FileItemPath( file-list )
Returns a delimited list of file paths.

FileLocate( filename )
Finds a file within the current DOS path.

FileMapName( filename, mapping-data )
Transforms a filename with a file wild-card mask and returns a new filename.

FileMove( source-list, destination, warning )
Moves files to another set of path names.

FileMoveAttr( source-list, destination, warning )
Moves files, and sets file attributes.

FileNameLong( filename )
Returns the long version of a filename.

FileNameShort( filename )
Returns the short (i.e., 8.3) version of a filename.

FileOpen( filename, mode [, Unicode [, timeout ]])
Opens a file for reading or writing.

FilePath( filename )
Returns path of a file.

FilePut( filename, string )
Writes a string to a file.

FilePutW( filename, Unicode string )
Writes a Unicode string to a file.

FileRead( filehandle )
Reads data from a file.

FileRename( source-list, destination )
Renames files to another set of names.

FileRoot( filename )
Returns root of a file.

FileSize( file-list [ ,format] )
Adds up the total size of a set of files.

FileSizeEx( file-list [ ,format] )
Finds the total size of a group of files (including open files).

FileTimeCode( filename )
Returns a machine readable/computable code for a file time.

FileTimeGet( filename )
Returns file date and time.

FileTimeGetEx( filename, time-field )
Gets extended time information for a file or directory.

FileTimeSet( list, datetime )
Sets the date and time of one or more files.

FileTimeSetEx( file-list, datetime, time-field )
Sets extended time information for one or more files.

FileTimeTouch( file-list )
Sets file(s) to current time.

FileVerInfo(filename, language-key, resource-string)
Returns a version resource string from a binary file.

FileWrite( filehandle, output-data )
Writes data to a file.

FileYmdHms( filename )
Returns a file time in the YmdHms datetime format.

InstallFile( filename, targname, default-targdir, delete-old, flags )
Installs a file.

ShortCutDir( name/csidl [, source [, add-slash]] )
Gets the path of a folder identified by a name or CSIDL value.

ShortcutEdit ( link-name, target, params, start-dir, show-mode [, shortcut-type] )
Modifies the specified shortcut file.

ShortcutExtra( link-name, description, hotkey, icon-file, icon-index [, shortcut-type] )
Sets additional information for the specified shortcut file.

ShortcutInfo( link-name [, shortcut-type] )
Returns information on the specified shortcut file.

ShortcutMake( link-name, target, params, start-dir, show-mode [, shortcut-type] )
Creates a shortcut for the specified filename or directory.

Pipe Functions

PipeClientClose( pipe-handle )
Closes a named pipe connection.

PipeClientOpen( pipe-name, timeout )
Connects to a named pipe.

PipeClientSendRecvData( pipe-handle, data, read-timeout )
Writes a message to a named pipe and then reads a message back.

PipeInfo( request, pipe-handle )
Returns information about a pipe or pipe operation.

PipeServerClose( pipe-handle, timeout )
Closes a named pipe instance.

PipeServerCreate( pipe-name, timeout )
Creates an instance of a named pipe and waits for a client to connect.

PipeServerRead( pipe-handle, timeout )
Reads a message from a named pipe.

PipeServerWrite( pipe-handle, data )
Writes a message to a named pipe.

String Handling

Char2Num( string )
Returns the ANSI code of a strings first character.

ChrGetCodePage( request )
Gets the current code page.

ChrHexToString( hex-string )
Converts a hex string to a string.

ChrHexToUnicode( hex-string [,flag] )
Converts a hex string to a Unicode string.

ChrSetCodePage( code-page )
Sets the current WIL code page.

ChrStringToHex( string )
Converts a string to a Hex string.

ChrStringToUnicode( string )
Converts an ANSI string to a Unicode string.

ChrUnicodeToHex( Unicode-string [,flag] )
Converts a Unicode string to a Hex string.

ChrUnicodeToString( Unicode-string )
Converts a Unicode string to an ANSI string.

IsFloat( string )
Tests whether a number can be converted to a floating point number.

IsInt( string )
Tests whether a number can be converted into a valid integer.

IsNumber( value )
Determines if a string represents a valid number.

ItemCount( list, delimiter )
Returns the number of items in a list.

ItemCountCsv( line, flags [, delimiter] )
Returns the number of items in a CSV line.

ItemExtract( index, list, delimiter )
Returns the selected item from a list.

ItemExtractCsv( index, line, flags [, delimiter] )
Returns the selected item from a CSV line.

ItemInsert( item, index, list, delimiter )
Adds an item to a list.

ItemLocate( item, list, delimiter )
Returns the position of an item in a list.

ItemRemove( index, list, delimiter )
Removes an item from a list.

ItemReplace( item, index, list, delimiter )
Replaces an item in a list.

ItemSort( list, delimiter )
Sorts a list.

Num2Char( integer )
Converts a number to its character equivalent.

ParseData( string )
Parses a passed string.

StrByteCount( string, request )
Returns the length of a string, in bytes.

StrCat( string [ ,string ] )
Concatenates strings together.

StrCharCount( string )
Counts the number of characters in a string.

StrClean( source-string, characters, replacement, match-case, mode )
Removes or replaces characters in a string.

StrCmp( string1, string2 )
Compares two strings.

StrCnt( string, sub-string, start-pos, end-pos, flags )
Counts the occurrences of a substring within a string.

StrFill( filler, length )
Builds a string from a repeated smaller string.

StrFix( base-string, pad-string, length )
Pads or truncates a string to a fixed length using characters.

StrFixBytes( base-string, pad-string, length )
Pads or truncates a string to a fixed length using bytes.

StrFixBytesL( base-string, pad-string, length )
Pads or truncates the left side of a string to a fixed length using bytes.

StrFixChars( base-string, pad-string, length )
Pads or truncates a string To a fixed length using characters.

StrFixCharsL( base-string, pad-string, length )
Pads or truncates the left side of a string to a fixed length using characters.

StrFixLeft( base-string, pad-string, length )
Pads or truncates the left side of a string to a fixed length using characters.

StriCmp( string1, string2 )
Compares two strings without regard to case.

StrIndex( base-string, sub-string, start, direction )
Locates a string within a larger string.

StrIndexNc( base-string, sub-string, start, direction )
Locates a string within a larger string, ignoring case.

StrIndexWild( string, pattern, start )
Finds wildcarded text within a larger string.

StrInsert (base-string, new-string, [pad-string [, start [, length]]])
Inserts a new string into an existing string.

StrLen( string )
Returns the length of a string.

StrLenWild( string, pattern, start )
Returns the length of wildcarded text within a larger string.

StrLower( string )
Converts a string to all lower-case characters.

StrOverlay( base-string, new-string, [pad-string [, start [, length]]] )
Overlays a new string onto an existing string.

StrReplace( string, old, new )
Replaces all occurrences of a sub-string with another.

StrScan( string, delimiters, startpos, direction )
Finds an occurrence of one or more delimiter characters in a string.

StrSub( string, startpos, length )
Returns a sub-string from within a string.

StrSubWild( string, pattern, start )
Extracts a substring matching wildcarded text from within a larger string.

StrTrim( string )
Trims leading and trailing blanks from a string.

StrTypeInfo( string, flag)
Gets character-type information for a string, or information for a character-type.

StrUpper( string )
Converts a string to all upper-case characters.

System Functions

About( )
Displays the About message box.

AppExist( program-name [, flags [, retries]])
Tells if an application is running.

AppWaitClose( program-name [, flags [, retries]])
Suspends WIL program execution until a specified application has been closed.

ComputerNameGet( format )
Gets the name associated with the local computer.

ComputerNameSet( new-computername, format )
Sets the name associated with the local computer.

Debug( mode [, init-string] )
Turns the Debug mode on or off.

DebugData( string, string )
Writes data via the Windows OutputDebugString function to the default destination.

DebugTrace ( requestcode [ ,parm1 [, parm2 ]] )
Controls and customizes the WIL debugging trace logs.

DirHome( )
Returns the initial directory path.

DirWindows( request# )
Returns the name of the Windows or Windows System directory.

DiskExist( drive letter )
Tests for the existence of a drive.

DiskFree( drive-list [, format] )
Finds the total available (unused) disk space on a group of drives.

DiskInfo( request# )
Returns information on the specified disk drive.

DiskScan( request# )
Returns a list of drives.

DiskSize ( request# [, format] )
Finds the total size of the specified drive(s).

DiskVolInfo( root-path, request# )
Returns information on a file system volume.

DllCall( dllfilename/dllhandle, returntype:entrypoint [ paramtype:param... ] )
Calls an external Dll.

DllCallCdecl( dllfilename/dllhandle, returntype:entrypoint [ ,paramtype:param... ] )
Calls an external DLL using the Cdecl calling convention.

DllFree( dllhandle )
Frees a Dll that was loaded via the DllLoad function.

DllHinst( partial-winname )
Obtains an application instance handle for use in DllCalls when required.

DllHwnd( partial-winname )
Obtains a window handle for use in DllCalls when required.

DllLastError()
Returns the most recent error returned by a DllCall to a Win32 API.

DllLoad( dllname )
Loads a Dll for later use via the DllCall function.

DOSVersion( level )
Returns the version numbers of the current version of DOS.

Drop( varname [,varname...] )
Deletes variables to recover their memory.

DropWild( variable/wildcard )
Removes variables from memory.

EndSession( )
Ends the current Windows session.

Environment( env-variable )
Gets a DOS environment variable.

EnvironSet( env-varname, newvalue )
Changes LOCAL Environment variables.

EnvItemize( )
Returns a delimited list of the current environment.

ErrorMode( mode )
Sets what happens in the event of an error.

Exclusive( mode )
Controls whether or not other Windows programs will get any time to execute.

Execute statement
Directly executes a WIL statement.

ExeTypeInfo( exefilename )
Returns an integer describing the type of EXE file specified.

GetExactTime( )
Returns the current time in hundredths of a second.

GetTickCount( )
Returns the number of clock ticks used by Windows since Windows started.

IntControl( request#, p1, p2, p3, p4 )
Special function which permits an internal operation.

KeyToggleGet( @key )
Returns the status of a toggle key.

KeyToggleSet( @key, value )
Sets the state of a toggle key and returns the previous value.

LastError ( )
Returns the last error encountered.

MouseInfo( request# )
Returns assorted mouse information.

MsgTextGet( window-name )
Returns the contents of a Windows message box.

NetInfo( request code )
Determines network(s) installed.

RtStatus()
Returns a number indicating the current execution mode of WinBatch.

SysParamInfo( request, value, ini-update )
Retrieves or sets the value of one of the system-wide parameters.

Terminate( expression, title, message )
Conditionally ends a WIL program.

Version( )
Returns the version of the parent program currently running.

VersionDLL( )
Returns the version of the WIL interpreter currently running.

WinExeName( partial-winname )
Returns the name of the executable file which created a specified window.

WinIsDOS( partial-winname )
Tells whether or not a particular window is a DOS or console-type window.

WinMetrics( request# )
Returns Windows system information.

WinResources( request# [, format] )
Returns information on available memory and resources.

WinSysInfo( )
Returns system configuration information.

WinVersion( level )
Returns the version of Windows that is currently running.

UAC Functions

UacElevationLevel ( )
Gets the current UAC elevation level.

UacExePromptTest ( programname )
Determines whether a program would require a UAC elevation prompt.

UacManifestSettings ( request )
Gets information on manifest and signature.