XCVault Command Line Options
XCVault.exe is a licensing utility that is by default installed with all PDF-XChange software. Its function is to facilitate managing license keys for PDF-XChange products. XCVault.exe is installed by default to:
C:\Program Files\Tracker Software\Vault
The command line options detailed below are available for the XCVault utility in the PDF-XChange family of products:
Usage: XCVault.exe command "<string>" [parameters]
•Strings that are passed are in angle brackets and should be in quotation marks "<>".
•Items that are optional are in square brackets [].
•Either/or options are separated by a pipe character |.
Supported Commands
-?
Displays help for the options available with XCVault.exe.
Syntax
xcvault.exe -?
-? accepts no options.
/AddKeys
This command installs all keys from .xcvault files.
Syntax
xcvault.exe /AddKeys "<filename>" [/M] [/S] [/R]
<filename> – The full path to the *.xcvault file that contains license keys to be installed on the machine.
/M – Installs keys into HKLM for per-machine use. This option requires administrative rights. If this option is not specified then key will be installed in HKCU for per-user use, and administrative rights are not required.
/S – Specifies silent mode and suppresses any messages with information about results.
/R – Specifies that new keys will be unencrypted when added. Please note that this does not affect existing keys.
Examples:
xcvault.exe /AddKeys "c:\\UNC\path\to\Personal.xcvault" - Adds the license defined in Personal.xcvault to HKCU that applies only to the current user.
xcvault.exe /AddKeys "c:\\UNC\path\to\Personal.xcvault" /S - Adds the license defined in Personal.xcvault to HKCU that applies only to the current user, and suppresses information about the result.
xcvault.exe /AddKeys "c:\\UNC\path\to\Personal.xcvault" /R - Adds the license defined in Personal.xcvault to HKCU in plain text (not encrypted) that applies only to the current user.
xcvault.exe /AddKeys "c:\\UNC\path\to\Personal.xcvault" /M /R - Adds the license defined in Personal.xcvault to HKLM in plain text (not encrypted) that applies to all users. This must be run with elevated privileges.
/AddKeyData
This command installs the specified key.
Syntax
xcvault.exe /AddKeyData "<KEYDATA>" [/M] [/S] [/R]
<KEYDATA> - At least the first ten characters of the key string. For example: "PVP10-IgrWIoT2Uv".
/M – Installs key into HKLM for per-machine use. This option requires administrative rights. If this option is not specified then key will be installed in HKCU for per-user use and administrative rights are not required.
/S – Specifies silent mode and suppresses any messages with information about results.
/R – Specifies that new keys will be unencrypted when added. Please note that this does not affect existing keys.
Examples:
xcvault.exe /AddKeyData "PXP10-CxL56n1SDEgUuF...+LB7kDyA" - Adds the license defined in "<KEYDATA>" to HKCU that applies to only the current user.
xcvault.exe /AddKeyData "PXP10-CxL56n1SDEgUuF...+LB7kDyA" /S - Adds the license defined in "<KEYDATA>" to HKCU that applies to only the current user, and suppresses information about the result.
xcvault.exe /AddKeyData "PXP10-CxL56n1SDEgUuF...+LB7kDyA" /R - Adds the license defined in "<KEYDATA>" to HKCU in plain text (not encrypted) that applies to only the current user.
xcvault.exe /AddKeyData "PXP10-CxL56n1SDEgUuF...+LB7kDyA" /M /R - Adds the license defined in "<KEYDATA>" to HKLM in plain text (not encrypted) that applies to all users. This must be run with elevated privileges.
/OpenKeys
This command stores all keys in an open form, instead of encrypting them by machine-specific ID. This option is useful for terminal servers that have a load-balancing and/or VDI environment.
Syntax
xcvault.exe /OpenKeys [/M] [/S]
/M – decrypts keys only in HKLM (per-machine). This option requires administrative rights. If it is not specified then the keys will be changed only in HKCU (per-user).
/S – specifies silent mode and suppresses any messages with information about results.
Examples:
xcvault.exe /OpenKeys - Decrypts all keys found in HKCU (current user).
xcvault.exe /OpenKeys /S - Decrypts all keys found in HKCU (current user) and suppresses information about the result.
xcvault.exe /OpenKeys /M /S - Decrypts all keys found in HKLM (all users) and suppresses information about the result.
/ProtectKeys
This command is the opposite of the /OpenKeys command:
Syntax
xcvault.exe /ProtectKeys [/M] [/S]
/M – encrypts keys only in the per-machine store (HKLM). This option requires administrative rights. If it is not specified then the keys will be changed only in the per-user store (HKCU).
/S – specifies silent mode and suppresses any messages with information about results.
Examples:
xcvault.exe /ProtectKeys - Enrypts all keys found in HKCU, (current user).
xcvault.exe /ProtectKeys /S - Enrypts all keys found in HKCU, (current user) and suppresses information about the result.
xcvault.exe /ProtectKeys /M /S - Enrypts all keys found in HKLM (all users) and suppresses information about the result.
/ActivateKeys
This command activates installed keys. Key activation associates a user with a device and a license key. Successful key activation sets a flag in HKCU. It is by definition a per-user action and cannot be done on a per-machine basis.
Syntax
xcvault.exe /ActivateKeys [/S] [/AA]
/S – specifies silent mode and suppresses any messages with information about results.
/AA – specifies that currently activated keys will be reused in the activation process.
Examples:
xcvault.exe /ActivateKeys /S – activates unactivated keys in HKCU (current user) and suppresses any messages with information about results
xcvault.exe /ActivateKeys /S /AA – activates all keys in HKCU (current user) and suppresses any messages with information about results. The state of all keys found on the activation server will be reflected locally.
/RemoveKeys
Removes all or specified license keys for all products from HKCU, (per-user). If modifying per-machine keys (HKLM - requires elevated rights) then all specified keys will be removed. If modifying per-user keys (HKCU - execute as the current user) then keys from HKLM will be marked as '_Removed' for the current user only. Removed keys are not used for the current user and hidden from them.
If /RemoveKeys is run as a system account rather than as a user that has been elevated then it will remove keys from HKLM but HKCU will not be affected. (_Removed registry keys will not be added).
If key filtering parameters are not specified and run from an elevated account then all keys will be removed.
Syntax
xcvault.exe /RemoveKeys "<KEYDATA>"|"<filename>" [/S] [/X]
<KEYDATA> - At least the first ten characters of the key string. For example: "PVP10-IgrWIoT2Uv".
<filename> - The full path to the .xcvault file that contains license keys to be removed from the machine.
/X - Specifies that only expired license keys should be removed. Expired keys are keys for which the maintenance period has expired.
/S - Specifies silent mode and suppresses any messages with information about results.
Examples:
xcvault.exe /RemoveKeys /S – removes all keys from HKCU (current user) and suppresses any messages with information about results
xcvault.exe /RemoveKeys /X /S – removes all expired keys from HKCU (current user) and suppresses any messages with information about results
xcvault.exe /RemoveKeys "PXP10-CxL56n1SDEgUuF" (no elevated rights) – removes the key specified in <KEYDATA> from HKCU (current user) and flags HKLM keys as _Removed in HKCU.
xcvault.exe /RemoveKeys "PXP10-CxL56n1SDEgUuF" (with elevated rights) – removes the key specified in <KEYDATA> from HKCU (current user) and HKLM (all users).
xcvault.exe /RemoveKeys "c:\\UNC\path\to\Personal.xcvault" (no elevated rights) – removes the key specified in Personal.XCVault from HKCU (current user) and flags HKLM keys as _Removed in HKCU.
xcvault.exe /RemoveKeys "c:\\UNC\path\to\Personal.xcvault" (with elevated rights) – removes the key specified in Personal.XCVault HKCU (current user) and HKLM (all users).
/ListKeys
Shows all license keys installed on the machine, in the format:
Location (U/M), Number of Keys, Key State (U/M/V/A/X/I), KEYDATA
U - key is located in HKCU (current user)
M - key is located in HKLM (all users)
V - key is valid
A - key is activated
X - key is expired
I - key is invalid or blocked
ListKeys accepts no arguments.
Syntax
xcvault.exe /ListKeys
Example:
XCVault.exe /ListKeys
C:\Program Files\Tracker Software\Vault>
Number of license keys: 2
01. M VA PXP10-4owLJECNLR54uz4psFKWYTQO...
02. M VA PEP10-GctKkTCGiS7YioKvEje27MCc...
/Cleanup
This command removes all license-related information for all installed products from per-machine (HKLM) and per-user (HKCU) stores. If the per-machine store is not empty then administrative rights are required.
Syntax
xcvault.exe /Cleanup [/S|
/S – specifies silent mode and suppresses any messages with information about results.
Examples:
xcvault.exe /Cleanup (no elevated rights) – removes all license-related information from HKCU (current user).
xcvault.exe /Cleanup /S (with elevated rights) – removes all license-related information from HKCU (current user) and HKLM (all users), and suppresses any messages with information about results.