This section explains each command that can use a parameter file, assuming that you will use a parameter file. When you can use both a parameter file and command arguments to specify parameters, this section assumes that you are using a parameter file to specify the parameters. If you want to use command arguments to specify the same parameters for the command, see the Format of the command without using a parameter file section in each command explanation.

In a parameter file, you code parameters required for the command execution by setting off the parameters by using tags depending on their meanings. To create a parameter file, you must first use the parameter file specification contents table to check the tags that correspond to the parameters to be set. Next, refer to 4.26.3 Tag specification method for details about how to specify the tags. For details about the tag types and about the parameter file format, see 4.26 Creating a parameter file.

If you specify both a parameter file and command arguments, the command arguments take precedence and the parameter file specifications are ignored (except that in the case of the dcmpkget command, some definitions in a parameter file may be valid. For details about the dcmpkget command, see 4.15 dcmpkget.exe (acquiring a backup of a package)).

The following sections explain the descriptions of each command.

Function

Describes the function of the command.

Format

Shows the command syntax. You can omit an argument that is enclosed in brackets. When you can use both a parameter file and command argument to specify the same parameter, this syntax assumes that you are using a parameter file to specify the command.

Format example:

dcmXXXX.exe [/A] [/B]
             /i parameter-file1 [parameter-file2]
 

In the preceding example, you can omit all the arguments except for /i parameter-file1. You can specify a maximum of two parameter files.

Arguments

Explains each argument shown in Format. The parameters explained in this section cannot be specified in a parameter file.

Parameters in a parameter file and corresponding command arguments

Shows a table that lists the parameters you specify in the parameter file for the command. When you can also use command arguments to specify the same parameters instead of using a parameter file, the table also describes the correspondence between each parameter in a parameter file and the command arguments.

For details about the specifications in a parameter file and details about the default values when omitting them, see 4.26 Creating a parameter file. If both a parameter file and a command argument are specified for the same parameter, the value specified by the command argument takes precedence, and the specification made by the parameter file is ignored.

Note that the title of this section changes to Parameters in a parameter file for a command that does not allow you to use command arguments to specify the contents of a parameter file.

Format of the command without using a parameter file

The following shows the command syntax when using only command arguments without a parameter file. A vertical bar (|) separating items means that one of the items can be selected.

Format example:

dcmXXXX.exe [/A|/B]
             /j job-name [/l job-folder-path]
 

In the preceding example, you can omit the arguments except for /j job-name. You can specify either /A or /B.

This item does not apply to commands in which the content of a parameter file cannot be specified by using an argument or commands for which a parameter file cannot be used.

Return codes

Explains the return codes that indicate the results of the command execution.

Notes

Explains the notes for the command, if any.

Examples:

Gives an example to explain how to execute the command.