dynabook Knowledge Base Article
Command-line Switches and Return Code Information for dynabook Component Packages [TC*.exe]
ISSUE
Command-line switches and return code information for dynabook component Packages published with file name syntax "TC*.exe". These packages include components such as driver-, firmware- or other types of installation files, applying to dynabook products.
Component Package example
NOTE:
- The setup and setupr switches are supported in packages built after April 2013 (WB version is 55.13.320.22)
- The scm switch is supported in packages built within 2011 and later.
RESOLUTION
| Short
USAGE INSTRUCTION
-
Switches are case-insensitve.
-
Unknown cmd commands are ignored.
-
Duplicate cmd, in case of wbt, is ignored. [The wbt is for pass-thru to package's own Tinstall]
-
Partial-known cmd results in error
-
Prefix with - or /
-
The first letter is usually sufficient
-
For switches that have additional data (such as -log"filename" , do not add a space between the switch and the starting quote. In the extractor UI, a space is shown, however, because that is how it will be passed to TInstall).
-
Order of switch does not matter.
AVAILABLE SWITCHES
RETURN CODE INFORMATION [EXIT CODES]
The main setup file return the following exit code (errorlevel), in case a problem while executing the file has been encountered:
- Return Code 1604:
Any internal error
- Return Code 1634:
Built-in detection indicates the package should not be installed
- Return Code 0:
Success performing file extraction only or exit setup without executing any items.
RESOLUTION
| Detailed
ADDITIONAL INFORMATION
- Target folder path: -d"folder"
- 1.) "folder" not given or blanks. Extraction is to a temp folder.
- 2.) "folder" is a absolute path. Extraction is to the given given folder.
- 3.) "folder" is a relative path. Then path is subpath of location of TC exe, or if -fN is given, it is subpath of folder with CSIDL number N (see later).
- 4.) Special case: .\ (without quotes, as in -d.\) is to same folder as TC exe.
- Note:
* Folder is created if not there.
* Folder names may include environment variables. If variable cannot be expanded, it it used without expansion.
* TC is run at as-invoker permission level. Extractor will show error if admin is required. In this case, TC has to be run as Administratror.
* Example: To do extract-only to c:\exfolder automatically: tc.exe -x -auto -d"c:\exfolder"
- Target folder using CSIDL: -fN
- The decimal number N is the CSIDL of the folder.
- For example, -f23 will set extraction folder to common_programs, which in vista is c:\programdata\microsoft\windows\start menu\programs
- Note:
* If -d is a full path, the -f switch is ignored.
* If ID is not recognized, the default is the subfolder in temp (i.e., switch is ignored) or whatever specified by -d switch if given.
* TC is run at as-invoker permission level. Extractor will show error if admin is required. In this case, TC has to be run as Administratror.
- The ones below are passed to Tinstall
-s or -silent
Request the Tinstall utility to not display its UI and run setup with the install parameters.
-t or -test
Request the Tinstall utility to do test, after setup is completed.
-testonly
Request the Tinstall utility to do test only (without running setup).
-wait20
To wait certain number of seconds after setup complete, before doing the test. Values from 1 to 600 seconds. A 20-second wait period is shown in the example.
-log"pathname"
Request the Tinstall utility to write log (usually in conjunction of -test and -testonly. A RSLT.CMD file with the test result is also created.) The path should already exist. Previous file is overwritten. Pathname support env-var. If name not given, log is same pathname as exe, but with .log.htm extenstion. The file is in htm format, the contents are enclosed in "table" tags. The file has no "htm" and "body" tags. There are two tables: top table shows component title, test information, and result of each test. The bottom table shows install conditions and final result. The top table is of "testdetails" class, and bottom table is of "installconditions". If log name is given and the extension is not htm, then it is an image build script log. This means the bottom table has the hidden attribute.
-scm
Request the Tinstall utility to return exit code of main setup or to translate its own exit code to SCCM compatible value. Note: when this switch is used, Tinstall will behave like CTO mode (i.e., Tinstall will not show the progress and install-complete windows).
-setup
-setupr
- 1a.) Use the -setup switch, if we want to append the external parameters to the TC built-in install parameters. This is the usual case. The external parameters are always passed to the raw setup, even when built-in parameters are not used due to current install mode.
- 1b.) Use the -setupr switch, if we want to use only the external parameters for the raw setup; the TC built-in parameters will not be used.
- 2.) The switch should come last, after all other TC switches, because all values afterward are passed to the raw setup.
- 3.) There should be at least a space after the -setup or -setupr switch. This is different from other TC switches (e.g. -wait and -log) where there should be no spaces after the switch (e.g., -wait20 -log"c:\temp\tc.log").
- 4.) Do not enclose the whole set of external parameters with double quotes.
- 5.) Do not escape double quotes just for the TC; just enter what is required by the raw setup.
Example:
TC00352600H.exe -auto -scm -setup /f:"c:\temp\setup.iss" would run the raw setup like: Setup.exe /s /f:"c:\temp\setup.iss"
In this example, the /s is the built-in parameter because we used the -auto switch for the TC. If we were to use the -setupr switch, the raw setup is run without built-in switch: Setup.exe /f:"c:\temp\setup.iss". The -auto and -scm still apply to the TC extractor and installer.
- DEV TEST
TC.exe -s -log"c:\temp\abc.log" -setup -abc /abc -setup ' "abc'de" -'f"def" ""abc"" "d "'
will run TINSTALLWB like
TINSTALLWB.exe -s -log "c:\temp\abc.log" -setup "-abc /abc -setup ' ""abc'de"" -'f""def"" """"abc"""" ""d ""'"
which will run rawsetup exe like rawsetup [built-in params if needed] -abc /abc -setup ' "abc'de" -'f"def" ""abc"" "d "'
- Package behavior for -auto and -silent
–auto
(Runs component automatically without user interface)
Runs component automatically. Once launched, the extractor will:
- open its main dialog;
- start extracting files to predefined temp or as given from command-line;
- launch tinstallwb.exe (or tinstall.exe) (unless -x from command-line for extraction only;
- wait for tinstallwb.exe (or tinstall.exe) to end to get exit code;
- attempt to delete content of extract folder (if enabled from UI, but will not attempt if at root of drive of folder has files initially);
- quit, returning exit code.
- If the main dialog shows error or error dialog pops up, the dialog will close and etractor will quit automatically after about five seconds.
–silent
(Runs component automatically without user interface)
Same as -auto, except the extract will not show is UI or any of its error dialogs. The tinstall and the associated setup program may still show UI.
- Folder ID (CSIDL)
CSIDL_FLAG_CREATE (0x8000)
Version 5.0. Combine this CSIDL with any of the following CSIDLs to force the creation of the associated folder.
NOT FOR USE WITH TSFX.
CSIDL_ADMINTOOLS (0x0030)
Version 5.0. The file system directory that is used to store administrative tools for an individual user. The Microsoft Management Console (MMC) will save customized consoles to this directory, and it will roam with the user.
CSIDL_ALTSTARTUP (0x001d)
The file system directory that corresponds to the user's nonlocalized Startup program group.
CSIDL_APPDATA (0x001a)
Version 4.71. The file system directory that serves as a common repository for application-specific data. A typical path is C:\Documents and Settings\username\Application Data. This CSIDL is supported by the redistributable Shfolder.dll for systems that do not have the Microsoft Internet Explorer 4.0 integrated Shell installed.
CSIDL_BITBUCKET (0x000a)
The virtual folder containing the objects in the user's Recycle Bin.
CSIDL_CDBURN_AREA (0x003b)
Version 6.0. The file system directory acting as a staging area for files waiting to be written to CD. A typical path is C:\Documents and Settings\username\Local Settings\Application Data\Microsoft\CD Burning.
CSIDL_COMMON_ADMINTOOLS (0x002f)
Version 5.0. The file system directory containing administrative tools for all users of the computer.
CSIDL_COMMON_ALTSTARTUP (0x001e)
The file system directory that corresponds to the nonlocalized Startup program group for all users. Valid only for Microsoft Windows NT systems.
CSIDL_COMMON_APPDATA (0x0023)
Version 5.0. The file system directory containing application data for all users. A typical path is C:\Documents and Settings\All Users\Application Data.
CSIDL_COMMON_DESKTOPDIRECTORY (0x0019)
The file system directory that contains files and folders that appear on the desktop for all users. A typical path is C:\Documents and Settings\All Users\Desktop. Valid only for Windows NT systems.
CSIDL_COMMON_DOCUMENTS (0x002e)
The file system directory that contains documents that are common to all users. A typical paths is C:\Documents and Settings\All Users\Documents. Valid for Windows NT systems and Microsoft Windows 95 and Windows 98 systems with Shfolder.dll installed.
CSIDL_COMMON_FAVORITES (0x001f)
The file system directory that serves as a common repository for favorite items common to all users. Valid only for Windows NT systems.
CSIDL_COMMON_MUSIC (0x0035)
Version 6.0. The file system directory that serves as a repository for music files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Music.
CSIDL_COMMON_PICTURES (0x0036)
Version 6.0. The file system directory that serves as a repository for image files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Pictures.
CSIDL_COMMON_PROGRAMS (0x0017)
The file system directory that contains the directories for the common program groups that appear on the Start menu for all users. A typical path is C:\Documents and Settings\All Users\Start Menu\Programs. Valid only for Windows NT systems.
CSIDL_COMMON_STARTMENU (0x0016)
The file system directory that contains the programs and folders that appear on the Start menu for all users. A typical path is C:\Documents and Settings\All Users\Start Menu. Valid only for Windows NT systems.
CSIDL_COMMON_STARTUP (0x0018)
The file system directory that contains the programs that appear in the Startup folder for all users. A typical path is C:\Documents and Settings\All Users\Start Menu\Programs\Startup. Valid only for Windows NT systems.
CSIDL_COMMON_TEMPLATES (0x002d)
The file system directory that contains the templates that are available to all users. A typical path is C:\Documents and Settings\All Users\Templates. Valid only for Windows NT systems.
CSIDL_COMMON_VIDEO (0x0037)
Version 6.0. The file system directory that serves as a repository for video files common to all users. A typical path is C:\Documents and Settings\All Users\Documents\My Videos.
CSIDL_CONTROLS (0x0003)
The virtual folder containing icons for the Control Panel applications.
CSIDL_COOKIES (0x0021)
The file system directory that serves as a common repository for Internet cookies. A typical path is C:\Documents and Settings\username\Cookies.
CSIDL_DESKTOP (0x0000)
The virtual folder representing the Windows desktop, the root of the namespace.
CSIDL_DESKTOPDIRECTORY (0x0010)
The file system directory used to physically store file objects on the desktop (not to be confused with the desktop folder itself). A typical path is C:\Documents and Settings\username\Desktop.
CSIDL_DRIVES (0x0011)
The virtual folder representing My Computer, containing everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.
CSIDL_FAVORITES (0x0006)
The file system directory that serves as a common repository for the user's favorite items. A typical path is C:\Documents and Settings\username\Favorites.
CSIDL_FONTS (0x0014)
A virtual folder containing fonts. A typical path is C:\Windows\Fonts.
CSIDL_HISTORY (0x0022)
The file system directory that serves as a common repository for Internet history items.
CSIDL_INTERNET (0x0001)
A virtual folder representing the Internet.
CSIDL_INTERNET_CACHE (0x0020)
Version 4.72. The file system directory that serves as a common repository for temporary Internet files. A typical path is C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
CSIDL_LOCAL_APPDATA (0x001c)
Version 5.0. The file system directory that serves as a data repository for local (nonroaming) applications. A typical path is C:\Documents and Settings\username\Local Settings\Application Data.
CSIDL_MYDOCUMENTS (0x000c)
Version 6.0. The virtual folder representing the My Documents desktop item.
CSIDL_MYMUSIC (0x000d)
The file system directory that serves as a common repository for music files. A typical path is C:\Documents and Settings\User\My Documents\My Music.
CSIDL_MYPICTURES (0x0027)
Version 5.0. The file system directory that serves as a common repository for image files. A typical path is C:\Documents and Settings\username\My Documents\My Pictures.
CSIDL_MYVIDEO (0x000e)
Version 6.0. The file system directory that serves as a common repository for video files. A typical path is C:\Documents and Settings\username\My Documents\My Videos.
CSIDL_NETHOOD (0x0013)
A file system directory containing the link objects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. A typical path is C:\Documents and Settings\username\NetHood.
CSIDL_NETWORK (0x0012)
A virtual folder representing Network Neighborhood, the root of the network namespace hierarchy.
CSIDL_PERSONAL (0x0005)
Version 6.0. The virtual folder representing the My Documents desktop item. This is equivalent to CSIDL_MYDOCUMENTS.
Previous to Version 6.0. The file system directory used to physically store a user's common repository of documents. A typical path is C:\Documents and Settings\username\My Documents. This should be distinguished from the virtual My Documents folder in the namespace. To access that virtual folder, use SHGetFolderLocation, which returns the ITEMIDLIST for the virtual location, or refer to the technique described in Managing the File System.
CSIDL_PRINTERS (0x0004)
The virtual folder containing installed printers.
CSIDL_PRINTHOOD (0x001b)
The file system directory that contains the link objects that can exist in the Printers virtual folder. A typical path is C:\Documents and Settings\username\PrintHood.
CSIDL_PROFILE (0x0028)
Version 5.0. The user's profile folder. A typical path is C:\Documents and Settings\username. Applications should not create files or folders at this level; they should put their data under the locations referred to by CSIDL_APPDATA or CSIDL_LOCAL_APPDATA.
CSIDL_PROFILES (0x003e)
Version 6.0. The file system directory containing user profile folders. A typical path is C:\Documents and Settings.
CSIDL_PROGRAM_FILES (0x0026)
Version 5.0. The Program Files folder. A typical path is C:\Program Files.
CSIDL_PROGRAM_FILES_COMMON (0x002b)
Version 5.0. A folder for components that are shared across applications. A typical path is C:\Program Files\Common. Valid only for Windows NT, Windows 2000, and Windows XP systems. Not valid for Windows Millennium Edition (Windows Me).
CSIDL_PROGRAMS (0x0002)
The file system directory that contains the user's program groups (which are themselves file system directories). A typical path is C:\Documents and Settings\username\Start Menu\Programs.
CSIDL_RECENT (0x0008)
The file system directory that contains shortcuts to the user's most recently used documents. A typical path is C:\Documents and Settings\username\My Recent Documents. To create a shortcut in this folder, use SHAddToRecentDocs. In addition to creating the shortcut, this function updates the Shell's list of recent documents and adds the shortcut to the My Recent Documents submenu of the Start menu.
CSIDL_SENDTO (0x0009)
The file system directory that contains Send To menu items. A typical path is C:\Documents and Settings\username\SendTo.
CSIDL_STARTMENU (0x000b)
The file system directory containing Start menu items. A typical path is C:\Documents and Settings\username\Start Menu.
CSIDL_STARTUP (0x0007)
The file system directory that corresponds to the user's Startup program group. The system starts these programs whenever any user logs onto Windows NT or starts Windows 95. A typical path is C:\Documents and Settings\username\Start Menu\Programs\Startup.
CSIDL_SYSTEM (0x0025)
Version 5.0. The Windows System folder. A typical path is C:\Windows\System32.
CSIDL_TEMPLATES (0x0015)
The file system directory that serves as a common repository for document templates. A typical path is C:\Documents and Settings\username\Templates.
CSIDL_WINDOWS (0x0024)
Version 5.0. The Windows directory or SYSROOT. This corresponds to the %windir% or %SYSTEMROOT% environment variables. A typical path is C:\Windows.
DOCUMENT DETAILS
Document ID:
Doc Type:
Online Date:
Date Modified:
Category:
Company:
Product Category:
Product Group:
Product Series:
Product:
Model Number:
Operating System:
Keywords:
DISCLAIMER
Dynabook provides this information "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability or fitness for a particular purpose. Dynabook shall not be responsible for the topicality, correctness, completeness or quality of the information or software provided. Dynabook is not liable for any damage caused by the use of any information or software provided, including information that is incomplete or incorrect. Any trademarks used herein belong to their respective owners.
Copyright Dynabook Europe GmbH. All rights reserved.
Back to top