The SfxMessages property contains the text that is displayed by the various information dialog boxes shown by the self-extractor. The values in this property are consulted by Xceed Zip when you are building a self-extracting Zip file.
As an indexed string property, each entry in the array is text used in a different information dialog box.
For 32-bit components, the maximum length string allowed for each entry in this property is 2000 characters, except for the license agreement message which can contain up to 8000 characters. For 16-bit components, the maximum length for all SfxMessages string entries are 255 characters.
If you do not want the self-extractor to display any messages or dialogs, use the SfxClearMessages method to disable them.
| Value | Meaning |
|---|---|
| xsmSuccess | This message is displayed in the Success dialog box upon successful extraction of all the files in the archive. The default value is "All files were successfully unzipped." |
| xsmFail | This message is displayed in the Fail dialog box if an error occurs during the extraction process. The following macros are available when specifying a value for the fail message: %e = The error code that caused the failure. The default value is "An error occurred while unzipping. One or more files were not successfully unzipped. The error code is %e." |
| xsmErrorCreatingFolder | This message is displayed in the Error Creating Folder dialog box. The following macros are available when specifying a value for ErrorCreatingDirMsg: %d = The folder that could not be created. The default value is "Unable to create folder '%d'." |
| xsmIntro | This message is displayed in the Introduction dialog box. The default value is "Welcome to the Xceed Zip Self-Extractor. This program will unzip some files onto your system." |
| xsmLicense | This is the message displayed in the License agreement dialog box. The license agreement dialog box allows you to display a license agreement and to force the user to either accept or reject the terms of the agreement. If the terms are rejected, the self-extractor will terminate and no files will be extracted. |
| xsmDestinationFolder | This prompt is displayed in the Select Unzip Folder dialog box. The prompt asks the user to select the path where the files will be extracted to. The default value is "Select the folder where you want to unzip the files to." |
| xsmPassword | This prompt asks the user to enter a password for a given file. It is displayed in the Password Prompt dialog box. The default value is "A password is required for file:" |
| xsmInsertLastDisk | This prompt asks the user to insert the last disk of the set of disks containing the self-extractor and its files. This prompt is used when the self-extractor spans multiple disks, and the last disk is required. The default value is "This self-extracting zip file is part of a multidisk zip file. Please insert the last disk of the set." |
| xsmInsertDisk | This prompt asks the user to insert a specific disk from the set of disks containing the self-extractor and its files. This prompt is used when the self-extractor spans multiple disks, and a specific disk is required. The following macros are available when specifying a value for InsertDiskPrompt: %n = The number of the requested disk. The default value is "Please insert disk #%n." |
| xsmAbortUnzip | This prompt asks the user if they really wish to abort the self-extracting process, after having clicked on the "Abort" button. The default value is "Are you sure you want to abort the unzipping process?" |
| xsmCreateFolder | This is the text displayed in the Create Folder dialog. The text informs the user that the folder where files will be unzipped to does not exist, and asks the user if they wish to create the folder. The following macros are available when specifying a value for CreateFolderPrompt: %d = The folder to create The default value is "Folder '%d' does not exist. Do you want to create it?" |
| xsmOverwrite | This prompt asks the user if they wish to overwrite a file that already exists. It is used in the Overwrite dialog. See the Overwrite setting for information on what choices the user has when the Overwrite dialog is displayed. The following macros are available when specifying a value for OverwritePrompt: %f = The path and filename of the file to overwrite The default value is "The file '%f' already exists. Do you want to overwrite it?" |
| xsmProgress | This is the string used to indicate which file is currently being extracted. It is used in the Progress dialog box. The default value is "Unzipping file:" |
The default value for each message is listed in the above table.
| Declaration (DLL API) | |
|---|---|
| |
No
None