(a) Format

Dim variable-name As variable-type

(b) Description

The Dim statement declares a variable. Code this statement just after a Function statement.

• variable-name (required)
  The variable names must be unique in one script. The characters that can be used in variable names are alphabetic characters (a to z and A to Z), numbers (0 to 9), and symbols (#, @, and _). The variable names must begin with an alphabetic character. Alphabetic characters are case sensitive. Up to 128 characters can be used in one variable name. Note that the following words cannot be used as variable names:
  
  • A statement descriptor of the script
    For statement descriptors that cannot be used as variable names, see Table D-1.
    
  • Name of a supported function
    For function names that cannot be used as a variable name, see Table D-2 in D.4 Script functions.
    
  • Name of a system variable in the script
    The following table shows system function names that cannot be used as a variable name:
    

    System variable names not allowed
    %HITACHI_REG	%NETMDMP%	%SYSTEM%
    %WINDOWS%	ACTIVE	ACTIVE_VERSION
    ALL_DRIVE	BACKUP_PROCESS	COLLECT_NORMAL
    COLLECTION_AFTER	COLLECTION_BEFORE	COLLECTION_END
    COLLECTION_NORMAL	COLLECTION_PROCESS	COLLECTION_START
    CREATEICON_PROCESS	CREATEPROGRAMGROUP_PROCESS	CREATESHORTCUT_PROCESS
    D_ALPHA	DELBACKUP_PROCESS	DmInfo
    EXIST	FALSE	FindFile
    FINDFILE_PROCESS	FORCE	FORCE_DELIVERY
    GDI_MEMORY	GetFileDate	GetFileSize
    I_286	I_386	I_486
    I_860	I_PENTIUM	INACTIVE
    INSTALL_CAPAERROR	INSTALL_DRIVE	INSTALL_HENVERROR
    INSTALL_NORMAL	INSTALL_PROCESS	INSTALL_PSVRERROR
    INSTALL_SENVERROR	IntegerToString	IsActive
    ISACTIVE_PROCESS	KIND_WINDOWS	KIND_WINDOWS95
    KIND_WINDOWSNT	M_MIPS	MISC_PROCESS
    MSDOS	MSGBOX_PROCESS	NO_ERROR
    NOEXIST	NOFORCE	OLD_VERSION
    P_POWERPC	PACKAGE_ID	PACKAGE_NAME
    REAL_MEMORY	RESTORE_PROCESS	SETSTATUS_PROCESS
    SETUP_DIRECTORY	SETUP_PROCESS	SHELL_PROCESS
    SYSINFOCOPROCESSOR_PROCESS	SYSINFOCPUTYPE_PROCESS	SYSINFOHDEMPTY_PROCESS
    SYSINFOMEMORY_GDIMEMORY_PROCESS	SYSINFOMEMORY_REALMEMORY_PROCESS	SYSINFOMEMORY_USERMEMORY_PROCESS
    SysInfoOSKind	SYSINFOOSVERSION_MSDOS_PROCESS	SYSINFOOSVERSION_WINDOWS_PROCESS
    TRUE	USER_MEMORY	VERINFO_PROCESS
    VERINFOEX_PROCESS	WINDOWS	--

    Legend: --: Not applicable

    
    
• As (required)
  Declare the type of the variable after As.
  
• variable-type (required)
  Specifies the type of the variable. The following types can be specified:
  

  Integer

  Indicates the integer type. When this is specified, the variable can store an integer from -32,768 to 32,767. The variable is initialized to 0 when it is declared.

  String

  Indicates the character string type. When this is specified, the variable can store 0 to 128 characters. The variable is initialized to a zero-length character string ("") when it is declared.

  System

  Indicates the system type. For some script functions for JP1/Software Distribution, a system-type variable must be specified as the return value. The system-type variables are not initialized when declared.

(a) Format

ErrorExit

(b) Description

The ErrorExit statement terminates the execution of a script abnormally. Installation or collection can be terminated at any time. If you want to make the script report a specified status code, set the status code using the SetStatus function before the ErrorExit statement.

(a) Format

Exit

(b) Description

The Exit statement terminates the execution of a script normally.

(a) Format

Function main()

(b) Description

The Function statement declares the beginning of a script. This statement must be used in pairs with an End Function. The statements between Function and End Function are processed as a script.

Function can be followed by only main().

(c) Notes

The script between Function and End Function cannot contain the following statements:

• Function statement
• End Function statement

(a) Format

End Function

(b) Description

The End Function statement declares the end of a script that begins with the Function statement.

(a) Format

Goto label-name

(b) Description

Makes the script processing jump to the label denoted by label-name. A jump cannot be made into any of the following statements:

• On InstallError statement
• On CollectionError statement
• If statement

A jump must always be a jump to a statement after the current statement. Note that a loop involving a jump to a prior statement cannot be coded.

• label-name (required)
  Specify a label name, which occurs after the Goto statement. The label names must be unique in one script. The characters that can be used in label names are alphabetic characters (a to z and A to Z), numbers (0 to 9), and symbols (#, @, and _). A label name must begin with an alphabetic character.
  Alphabetic characters are case sensitive. Up to 128 characters can be used in one label name.
  

(c) Example

Goto Label01
    :
Label01:           ' (The label must be followed by a colon (:).)
    statements

(a) Format

If condition
Then
statements-to-be-executed-when-the-condition-is-true
Else
statements-to-be-executed-when-the-condition-is-false
End If

(b) Description

This statement evaluates the condition and makes the script processing branch depending on the result of the evaluation.

• condition (required)
  Specify a condition for making the script processing branch. The condition is coded in a left-hand-expression comparison-operator right-hand-expression.
  In the left- and right-hand expressions, you can code expressions using character strings, character string expressions, numeric values, numeric expressions, system variables, script functions, and the return values of script functions.
  
• Then (required)
  Specify this descriptor in pairs with an If statement. When the evaluation result of the condition is true, the statements after Then are executed.
  
• statements-to-be-executed-when-the-condition-is-true (required)
  Specify the statements to be executed when the evaluation result of the condition is true. The statements between Then and Else or End If are executed when the result is true.
  
• Else
  This descriptor is optional. The statements after Else are executed when the evaluation result of the condition is false.
  
• statements-to-be-executed-when-the-condition-is-false
  These statements are required when Else is specified. Specify the statements to be executed when the evaluation result of the condition is false. The statements between Else and End If are executed when the result is false.
  
• End If (required)
  Specify this descriptor in pairs with an If statement. This descriptor indicates the end of the If statement.
  

(c) Notes

The statements following Then or Else cannot contain the following statements:

• Function statement
• End Function statement
• Dim statement
• If statement
• Label name
• On InstallError statement
• On CollectionError statement

(a) Format

On InstallError
    Do
        any-postprocessing
    End

(b) Description

In this statement, code the statements for the postprocessing if an error occurs during execution of an installation script.

The functions for JP1/Software Distribution such as Install() and Shell() immediately terminate the script if an error occurs. Therefore, the return value of the functions cannot be checked by the installation script. In this case, if postprocessing is necessary, describe the necessary processing in an On InstallError statement. The On InstallError statement can be applied to displaying a specific message on the console or outputting it to a log file at the occurrence of an installation error.

If an error occurs during the postprocessing described in the On InstallError statement, the subsequent statements are not processed and the script is terminated.

The On InstallError statement can be coded anywhere in an installation script after the Dim statement. However, for readability, code it just after the Dim statement if possible.

• Do (required)
  This indicates the beginning of the postprocessing.
  
• any-postprocessing (required)
  Specify the postprocessing to be executed if an error occurs during the execution of an installation script. The statements before End are recognized as the postprocessing.
  
• End (required)
  This indicates the end of the postprocessing.
  

(c) Example

Function main()
      :
    On InstallError
    Do
        LogFile("Error occurred during installation.")
    End
      :
      :
    Install("c:\")
      :
End Function

(d) Notes

The postprocessing cannot contain the following:

• Dim statement
• Exit statement
• Function statement
• End Function statement
• Goto statement
• On InstallError statement
• Label name
• Install function
• Setup function
• CreateProgramGroup function
• CreateShortCut function
• CreateIcon function

(a) Format

On CollectionError
    Do
        any-postprocessing
    End

(b) Description

In this statement, code the statements for the postprocessing if an error occurs during the execution of a collection script.

The functions for JP1/Software Distribution such as Collection() and Shell() immediately terminate the script if an error occurs. Therefore, the return value of the functions cannot be checked by the collection script. In this case, if postprocessing is necessary, code the necessary processing in an On CollectionError statement. The On CollectionError statement can be applied to outputting a specific message to a log file at the occurrence of a collection error.

If an error occurs during the postprocessing described in the On CollectionError statement, the subsequent statements are not processed and the script is terminated.

The On CollectionError statement can be coded anywhere in an installation script after the Dim statement. However, for readability, code it just after the Dim statement if possible.

• Do (required)
  This indicates the beginning of the postprocessing.
  
• any-postprocessing (required)
  Specify the postprocessing to be executed if an error occurs during the execution of a collection script. The statements before End are recognized as the postprocessing.
  
• End (required)
  This indicates the end of the postprocessing.
  

(c) Example

Function main()
      :
    On CollectionError
    Do
        LogFile("Error occurred during collection.")
    End
      :
      :
    Collection("c:\users\default\user.data")
      :
End Function

(d) Notes

The postprocessing cannot contain the following:

• Dim statement
• Exit statement
• Function statement
• End Function statement
• Goto statement
• On CollectionError statement
• Label name
• Collection function

(a) Format

Rem comment
' comment

(b) Description

You can code your comment in a script using the Rem statement. The portion from the single quotation mark (') or Rem up to the next return code is assumed to be a comment. You can code a comment anywhere in the script file.

• comment
  You can write any comment. Place one or more spaces or tab characters between Rem and the comment. There are no restrictions on the characters that can be used to write a comment.