Other Sections, Keys, and Values
Applies To: Windows 7, Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2, Windows Server 2008, Windows Server 2008 Foundation, Windows Server 2008 R2, Windows Server 2012, Windows Vista
This topic covers sections, keys, and values that might appear in service (.cms) files, particularly those created with older versions of the Connection Manager Administration Kit (CMAK) wizard.
Formats and conventions
Connection Manager creates service (.cms) files, which use the same format as Windows initialization (.ini) files and information (.inf) files. These files have several things in common:
Each file is divided into sections, with specific entries, called keys, assigned to the sections. A section heading is enclosed within brackets ([ ]). For example, [Strings] is a section containing text strings for messages. The keys for a section are not enclosed within brackets.
Each value specified for a numeric key must be an integer. Any noninteger value is truncated to an integer or ignored as invalid data. For example, 1.1 is truncated to 1 or ignored.
The order in which sections appear is not important; a particular section can be placed anywhere in the file.
Each comment in the file begins with a semicolon (;).
Table of other sections, keys, and values
The following table shows valid sections, keys, and values in the .cms file, the function and use of each key, and where each key can be set. You can set different keys in the CMAK wizard or the .cms file. If you change the .cms file with a text editor, rather than by using the Advanced Customization page of the CMAK wizard, you must rebuild the profile afterward with the CMAK wizard.
Note
In the following table, keys controlled by specific panes of the CMAK wizard are identified in the Set in column as CMAK. Although these keys appear in the .cms file, you should use the CMAK wizard to update these keys. If you change these keys by editing the .cms file, the CMAK wizard might overwrite them if you run it again on the same profile. Keys set in the Advanced Customization pane of the CMAK wizard are identified as .cms or .cmp, as appropriate.
Note
Make sure that locations are specified either as the full path or in reference to the location of the .cmp file.
[Section] or key | Value | Set in | ||
---|---|---|---|---|
[Logging] |
Section header for logging keys. |
.cms |
||
FileDirectory |
Location of the log file. If the value is blank, the log file is created in the temp folder. |
.cms |
||
MaxFileSize |
The maximum file size (in kilobytes) before the log is cleared. The file size is checked at initialization to prevent data loss during a connection. The default is 100. |
.cms |
||
[Menu Options] |
Shortcut menu that appears when a user right-clicks the notification area shortcut for your service.
|
CMAK .cms |
||
MenuItemName |
Command to be run from the shortcut menu. Shortcut menu commands use the format MenuItemName = Program, where MenuItemName is the descriptive name that appears on the shortcut menu and Program is the name of the executable file (.exe or other shell executable), including any parameters required for the program. For example, if you wanted to add Notepad to the menu with the command name "Editor," the line would be Editor = Notepad.exe. Default commands = Status and Disconnect. These programs are available in a shortcut menu that appears when a user right-clicks the notification area shortcut. Applications are listed in the menu in the same sequence as they are listed in the .cms file. |
CMAK |
||
[Animated Logo] |
Animation for the Connection Manager logon dialog box. The [Animated Logo] section specifies the location of the animation (.spl or .swf) file. This function is provided for compatibility with Connection Manager 1.0, which supports Macromedia Flash animation files. AnimatedLogo in the [Connection Manager] section determines whether an animation is used. |
.cms |
||
Movie |
Location of the animation file displayed in place of the static bitmap in the logon dialog box. Settings in the [Animated Actions] section control how the animation plays based on the connection state. |
.cms |
||
Parameter |
Other animation parameters passed from software used to create the animation, such as Quality = 3. |
.cms |
||
[Animated Actions] |
When to play segments of the animation. |
CMAK .cms |
||
Initial |
Starting frame number; plays when Connection Manager starts. |
.cms |
||
Dialing0 |
Starting frame number; plays while the primary phone number is dialed. |
.cms |
||
Pausing |
Starting frame number; plays during pauses between dials. |
.cms |
||
Dialing1 |
Starting frame number; plays while the backup phone number is dialed. |
.cms |
||
Authenticating |
Starting frame number; plays during user authentication. |
.cms |
||
Tunneling |
Starting frame number; plays while establishing a VPN connection. |
.cms |
||
Connected |
Starting frame number; plays when a connection is established. |
.cms |
||
Error |
Starting frame number; plays at any connection error. |
.cms |
||
[CustomButton Actions] |
Controls what programs start when the custom button is clicked. The format of the value is # = Program, where # is an ID number from 0 to n and Program is the complete name of the program, including the extension and the path to the program. Programs start in sequence: 0 first, 1 next, and so on. Custom button programs cannot be DLL files. |
CMAK .cms |
||
[Profile Format] |
Connection profile version. |
CMAK .cms .cmp |
||
Version |
Format version of the profile or service file. |
.cms .cmp |