Topic: Internal Commands  (Read 487 times)

0 Members and 1 Guest are viewing this topic.

Internal Commands
« on: October 14, 2015, 01:54:46 AM »

Lancelot

  • Moderator, Gena Baker
  • Grand Chef
  • *****
  • Date Registered: Sep 2010
  • Posts: 6984
Here are internal commands from builder.

Since winbuilder have lots of bugs,
 some commands are not usable,
 some commands are replaced with Call commands.
   If you are looking for some special things, be carefull.

There is "Wand" available ( right click on builder editor )
 where you can get info about how to use commands.

Below List is quite new,
 There would be things missing,
   Always check project plugins to see how commands used.
     In most cases failure of a syntax is due to a bug.

ps: Also use Utils\RegCPE to convert .reg files to plugin format
RegCPE not only make conversion but also workaround some known bugs.

I will try to update much more info (how to use syntax etc.)
 and add some known bug workarounds in time.



Here they are:


'AddInterface,%ScriptFile%[,Interface],Prefix'
--- NOT COMPATIBLE - DO NOT USE
See
Call,AddInterface
http://TheOven.org/index.php?topic=45.0
Also check relevant
Change Interface
http://theoven.org/index.php?topic=140.0

'AddVariables,%ScriptFile%,Section'

'Beep,ASTERISK'
'Beep,CONFIRMATION'
'Beep,ERROR'
'Beep,OK'
'Beep,WARNING'

ps: Beep not preferred ( %99.9 not used)

'DirCopy,FromDir,ToDir[,SHOW]'
'DirDelete,DirToDelete[,FAST]'
'DirMake,NewDir'
'DirMove,MoveDir,ToDir'

'Expand,CABfile,DirToDecompress[,SingleFile]'
'ExtractAllFiles,%ScriptFile%,Folder,DirToExtract'
'ExtractAllFilesIfNotExist,%ScriptFile%,Folder,DirToExtract'
'ExtractAndRun,%ScriptFile%,Folder,FileName[,"Parameters"]'
'ExtractFile,%ScriptFile%,Folder,AttachedFile,DirToExtract'

'CopyOrExpand,FileToCopyOrExpand,DestinationFolderOrFilename'
'FileCopy,FromFile,ToDir[,NOREC][,SHOW]'
'FileCreateBlank,NewFile'

'FileDelete,FileToDelete[,NOREC]'
Also See
Call,FileDelete
http://TheOven.org/index.php?topic=45.0

'FileRename,OldFilename,NewFilename'
Also See
Call,FileRename
http://TheOven.org/index.php?topic=45.0


'Hive,Delete,Section[,Key]'
'Hive,Load,HiveFilename'
'Hive,Read,Section,Key,%VarResult%'
'Hive,UnLoad'
'Hive,Write,0x0,Section,Key(Empty)'
'Hive,Write,0x1,Section,Key(Text),String'
'Hive,Write,0x2,Section,Key(ExpandedString),%tempdir%'
'Hive,Write,0x3,Section,Key(Binary),00,05,f3'
'Hive,Write,0x4,Section,Key(Number),1000'
'Hive,Write,0x7,Section,Key(MultiString),value1,value2'


'If,%Value1%,BIGGER,%Value2%,Command'
'If,%Value1%,EQUAL,%Value2%,Command'
'If,%Value1%,SMALLER,%Value2%,Command'
'If,EXISTDIR,Directory,Command'
'If,EXISTFILE,TestFile,Command'

'If,EXISTMACRO,Macro,Command'
--> NOT USED - NOT COMPATIBLE

'If,EXISTREGKEY,HKLM,Section,Key,Command'
'If,EXISTREGMULTI,HKLM,Section,Key,SubVal,Command'
'If,EXISTREGSECTION,HKLM,Section,Command'
'If,EXISTSECTION,TestFile,Section,Command'
'If,EXISTVAR,%Var%,Command'
'If,LICENSE,License.txt,Command'
--> NOT USED - NOT useable

'If,ONLINE,Command'
--> NOT USED - Bug
'If,PING,0.0.0.0,Command'
--> NOT USED - Bug

'If,QUESTION,QuestionText[,10,' + cTrue + '],Command'
'If,RUNS,[Path\]ExeName,Command'
'Else,Command'

'IniAddSection,IniFile,Section'
'IniDelete,IniFile,Section,Key'
'IniDeleteSection,IniFile,Section'
'IniMerge,UpdatedINIfile,INIfileToUpdate'
'IniRead,IniFile,Section,Key,%VarResult%'
'IniReadEsc,IniFile,Section,Key,%VarResult%'
'IniWrite,IniFile,Section,Key,Value'

'IniWriteTextLine,IniFile,Section,StringLine[,APPEND]'
APPEND Not Compatible, Use
'IniWriteTextLine,IniFile,Section,StringLine'

'RegGetNext,HKLM,Section,%VarResult%'
--> NOT USED

'RegHiveLoad,SectionName,HiveFilename'
'RegHiveUnLoad,SectionName'

most used RegHiveLoad and Unload:
Code: [Select]
RegHiveLoad,Tmp_Default,%RegDefault%
RegHiveLoad,Tmp_Software,%RegSoftware%
RegHiveLoad,Tmp_System,%RegSystem%
//--
RegHiveUnLoad,Tmp_Default
RegHiveUnLoad,Tmp_Software
RegHiveUnLoad,Tmp_System





'RegImport,RegFileToImport'
--> NOT USED


'RegMulti,HKLM,Section,Key,APPEND,String'
'RegMulti,HKLM,Section,Key,BEFORE,SubVal,String'
'RegMulti,HKLM,Section,Key,BEHIND,SubVal,String'
'RegMulti,HKLM,Section,Key,DELETE,SubVal'
'RegMulti,HKLM,Section,Key,INDEX,SubVal,%Index%'
'RegMulti,HKLM,Section,Key,PLACE,Index,String'
'RegMulti,HKLM,Section,Key,PREPEND,String'


'RegRead,HKLM,Section,Key,%VarResult%'

'RegReadBin,HKLM,Section,Key,%VarResult%'

See
Call,RegMultiSZ
Call,RegWriteBinaryBit
http://TheOven.org/index.php?topic=45.0

'RegWrite,HKLM,0x0,Section,Key(Empty)'
'RegWrite,HKLM,0x1,Section'
'RegWrite,HKLM,0x1,Section,Key(Text),String'
'RegWrite,HKLM,0x2,Section,Key(ExpandedString),%tempdir%'
'RegWrite,HKLM,0x3,Section,Key(Binary),00,01,00'
'RegWrite,HKLM,0x4,Section,Key(Number),1000'
'RegWrite,HKLM,0x7,Section,Key(MultiString),value1,value2'
'RegWriteBin[Ex],HKLM,0x?,Section,Key,53,00,55,00,00,00'

ps: 0x0 and 0x7 are problematic, check available plugins, more info later here.


'Retrieve,DIR,StartDir,%VarResult%'
'Retrieve,FILE,StartDirAndFiletype,%VarResult%'
'Retrieve,FILESIZE,QueryFile,%VarResult%'
'Retrieve,FILEVERSION,QueryFile,%VarResult%'
'Retrieve,FOLDERSIZE,Directory,%VarResult%'
'Retrieve,MD5,QueryFile,%VarResult%'

ps: FileSize or / and FolderSize have a size limit, do not use for big sizes

'Set,%Var%,NewValue[,{GLOBAL|PERMANENT}]'

'SetEsc,%Var%,NewValue[,{GLOBAL|PERMANENT}]'
--> NOT USED

'ShellExecute,Explore,TargetFile,"Parameters"'
--> NOT USED
See
Call,OpenDir
http://TheOven.org/index.php?topic=45.0

'ShellExecute,Hide,ExeFile,"Parameters"'
'ShellExecute,Open,ExeFile,"Parameters"'

'ShellExecute,Print,PrintFile,"Parameters"'
--> NOT USED


'ShellExecuteDelete,Hide,ExeFile,"Parameters"'
'ShellExecuteDelete,Open,ExeFile,"Parameters"'


'ShellExecuteEx,Explore,TargetFile,"Parameters"'
--> NOT USED
See
Call,OpenDir
http://TheOven.org/index.php?topic=45.0

'ShellExecuteEx,Hide,ExeFile,"Parameters"'
'ShellExecuteEx,Open,ExeFile,"Parameters"'

'ShellExecuteEx,Print,PrintFile,"Parameters"'
--> NOT USED


'StrFormat,BYTES,%Var%'
'StrFormat,CEIL,%Var%[,size]'
--> NOT USED
'StrFormat,CHARTOOEM,String,%VarResult%'
--> NOT USED

'StrFormat,CTRIM,String,SingleChar,%VarResult%'
'StrFormat,DATE,%VarResult%,"yyyy-mmm-dd hh:nn am/pm"'

'StrFormat,DEC,%Var%,integer'
'StrFormat,DIV,%Var%,integer'
'StrFormat,MULT,%Var%,integer'

ps: reminding integer ( ex: do not use 3.2 )

'StrFormat,EXT,FullFilename,%VarResult%'
'StrFormat,FILENAME,FullFilename,%VarResult%'
--> See also
Call,FileNameNoExt
http://TheOven.org/index.php?topic=45.0



'StrFormat,FLOOR,%Var%[,size]'
--> NOT USED

'StrFormat,HEX,IntValue,%VarResult%'
--> NOT USED

'StrFormat,INC,%Var%,integer'
'StrFormat,LCASE,String,%VarResult%'
'StrFormat,LEFT,String,Count,%VarResult%'

'StrFormat,LEN,String,%VarResult%'
--> NOT USED
See
Call,StringLength
http://TheOven.org/index.php?topic=45.0

'StrFormat,LONGPATH,FilePath,%VarResult%'
--> NOT USED

'StrFormat,LTRIM,String,Count,%VarResult%'
'StrFormat,MID,String,Start,Count,%VarResult%'
'StrFormat,NTRIM,String,%VarResult%'

'StrFormat,OEMTOCHAR,String,%VarResult%'
--> NOT USED

'StrFormat,PATH,FullFilename,%VarResult%'
'StrFormat,POS,String,SubString,%VarResult%'
'StrFormat,REPLACE,String,CharsToReplace,ReplacementChars,%VarResult%'
'StrFormat,RIGHT,String,Count,%VarResult%'
'StrFormat,RTRIM,String,Count,%VarResult%'
'StrFormat,SHORTPATH,FilePath,%VarResult%'
'StrFormat,SPLIT,String,DelimiterChar,Index,%VarResult%'
'StrFormat,UCASE,String,%VarResult%'

'System,CURSOR,NORMAL'
'System,CURSOR,WAIT'
'System,ERROROFF[,2]'
'System,FILEREDIRECT,{OFF|ON}'

'System,GETENV,EnvironmentVar,%VarResult%'
--> NOT USED DO NOT USE
May have 32bit/64bit bug
See
--->
Call,Host<Misc>
http://TheOven.org/index.php?topic=45.0
also
Call,Host<Time>
Call,Host<Folder>


'System,GETFILESYSTEM,Path,%VarResult%'
NOT USED
See
-->
Call,DriveGetFileSystem
http://TheOven.org/index.php?topic=45.0
also
Call,DriveGetType

'System,GETFREEDRIVE,%VarResult%'
'System,GETFREESPACE,Path,%VarResult%'

'System,HASDOS8_3,%VarResult%'
-->
NOT USED
See
http://TheOven.org/index.php?topic=45.0
Call,Dot83Support

'System,HASUAC,%VarResult%'
--> NOT USED DO NOT USE
See
Call,HostUAC
http://TheOven.org/index.php?topic=45.0

'System,ISADMIN,%VarResult%'
--> NOT USED DO NOT USE
See
Call,HostIsAdmin
http://TheOven.org/index.php?topic=45.0

'System,ISTERMINAL,%VarResult%'
--> NOT USED
[CodeBox]
Call,HostSessionName
Set,%t%,0
If,%HostSessionName%,Equal,Console,Set,%t%,1
If,%HostSessionName%-,Equal,-,Set,%t%,1
Echo,SessionName=%HostSessionName%
If,%t%,Equal,0,Echo,"Info: Builder run on Terminal Connection SessionName=%HostSessionName%",Warn
[CodeBox]


'System,LOG,{OFF|ON}';
--> NOT USED

'System,ONBUILDEXIT,command'
'System,ONSCRIPTEXIT,command'
---> Special case project commands not for any plugin
--> DO NOT USE

'System,REBUILDVARS'
---> Not used anymore !!!!
--> NOT USED DO NOT USE

'System,REFRESHINTERFACE'
'System,REGREDIRECT,{64|32|OFF}'
'System,RESCANSCRIPTS'
'System,SAVELOG,logfile.html'
'System,SPLITPARAMETERS,{OFF|ON}'

'TXTAddLine,TextFile,StringLine,APPEND'
'TXTAddLine,TextFile,StringLine,PLACE,LineNumber'
'TXTAddLine,TextFile,StringLine,PREPEND'
'TXTDelEmptyLines,TextFile'
'TXTDelLine,TextFile,StringToDelete'
'TXTDelSpaces,TextFile'
'TXTReplace,TextFile,OldString,NewString'



'WebGet,FileToDownload,FileOnDisk,[MD5],[Comment],[Timeout]'
'WebGetIfNotExist,FileToDownload,FileOnDisk,[MD5],[Comment],[Timeout]'

--> NOT USED DO NOT USE - It has numerous bugs
--->
See
Call,Download
http://TheOven.org/index.php?topic=45.0

'Exec,%ScriptFile%,Section'
'Run,%ScriptFile%,Section'
'Loop,%ScriptFile%,Section,start,end'
'Loop,BREAK'

'GetParam,Index,%VarResult%'
 --> NOT USED DO NOT USE
'PackParam,first,%VarResult%[,%Num%]'
 --> NOT USED DO NOT USE (only once inside MacroLibrary)

'Exit,ExitMessage'
'Halt,ExitMessage'

'Wait,seconds'
--->
NOT preferred, very rarely used, do NOT prefer


'Echo,MessageText'
'Echo,MessageText,WARN'

'Message,MessageText,ERROR[,10]'
'Message,MessageText,INFORMATION[,10]'
'Message,MessageText,WARNING[,10]'
--->
See
Call,Echo
http://TheOven.org/index.php?topic=45.0
for most used Echo and Message combinations



'Encode,%ScriptFile%,Folder,FileName'
--->
For special plugins

'FileByteExtract,FilesToSearch,OutputFile,ByteSignature,BytesLength'
--->
Rarely used on Gena for only 1 goal
« Last Edit: June 06, 2016, 01:57:18 AM by Lancelot »

 

Powered by EzPortal