home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / firunpkg.zip / wpinsobj.hlp (.txt) < prev    next >
OS/2 Help File  |  1997-11-13  |  13KB  |  496 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Install helper object ΓòÉΓòÉΓòÉ
  3.  
  4. Install helper objects provide a way to automatically set an install object's 
  5. settings, using a set of pre-defined keywords that correspond to the settings. 
  6. One or more keyword=value lines are entered in the install helper object. The 
  7. install helper object can then be dropped onto an install object to set the 
  8. values of the install object's settings. 
  9.  
  10. The advantages of using install helper objects are: 
  11.  
  12.      The settings for an install object can be pre-configured and activated at 
  13.       a later date. 
  14.      Install objects can be initialized repeatedly for testing purposes. 
  15.      Frequently made changes can be done with one drag and drop action. 
  16.  
  17.  To use an install helper object: 
  18.  
  19.    1. Drag the install helper template to a folder or to the desktop to create 
  20.       a new install helper object. 
  21.  
  22.    2. Open the install helper object's Setting Notebook and enter in the 
  23.       desired keyword=value line(s) on the Object Data page. Change the title 
  24.       on the General page to any unique name. Close the Setting Notebook to 
  25.       save the information. 
  26.  
  27.    3. Drag and drop the customized install helper object onto the desired 
  28.       install object or vice-versa. 
  29.  
  30.  
  31. ΓòÉΓòÉΓòÉ 2. Keyword=Value Lines ΓòÉΓòÉΓòÉ
  32.  
  33. A keyword=value line specifies the value for a particular install object 
  34. setting. 
  35.  
  36. The keyword=value line follows the syntax: 
  37.  
  38.         KEYWORD=VALUE;
  39.  
  40. Where the string VALUE will be copied verbatim to the setting specified by 
  41. KEYWORD in the install object Settings notebook. 
  42.  
  43. A blank VALUE will clear the corresponding setting's text field. 
  44.  
  45. To specify multiple lines for a particular setting, use a terminating semicolon 
  46. ONLY on the last line. 
  47.  
  48. The correct form is: 
  49.  
  50.         KEYWORD=LINE1
  51.         LINE2
  52.         LINE3;
  53.  
  54.  
  55. ΓòÉΓòÉΓòÉ 3. Install Helper Template ΓòÉΓòÉΓòÉ
  56.  
  57. This template can be dragged onto the desktop to create a new install helper 
  58. object. The system editor is displayed when the new object is opened. The 
  59. install helper object can then be customized by entering specific keywords into 
  60. the editor. When the edit session is saved, the data is saved in the install 
  61. helper object. 
  62.  
  63.  
  64. ΓòÉΓòÉΓòÉ 4. User Object ΓòÉΓòÉΓòÉ
  65.  
  66. The User object, found in the Installation Frameworks folder, is an install 
  67. helper object with the setting MODE=USER entered on the Object Data page of its 
  68. Settings notebook. 
  69.  
  70.  
  71. ΓòÉΓòÉΓòÉ 5. Developer Object ΓòÉΓòÉΓòÉ
  72.  
  73. The Developer object, found in the Installation Frameworks folder, is an 
  74. install helper object with the setting MODE=DEVELOPMENT entered on the Object 
  75. Data page of its Settings notebook. 
  76.  
  77.  
  78. ΓòÉΓòÉΓòÉ 6. Keywords ΓòÉΓòÉΓòÉ
  79.  
  80. Keywords correspond to install object settings, found in the install object's 
  81. Settings notebook. Keyword=value lines are entered in the Object Data page of 
  82. the install helper object, which can then be dropped onto an install object to 
  83. set the install object's settings. 
  84.  
  85. Select from the following list for a description of available keywords: 
  86.  
  87. General Install Object Information
  88. Settings notebook Information Page 1
  89. Settings notebook Information Page 2
  90. Settings notebook Dependencies Page
  91. Settings notebook Variables
  92. Settings notebook User Exits
  93. Settings notebook Objects Page 1
  94. Settings notebook Objects Page 2
  95. Settings notebook Media
  96. Settings notebook File List
  97. Settings notebook Compression
  98. Settings notebook Configure Page 1
  99. Settings notebook Configure Page 2
  100. Settings notebook Configure Page 3
  101. Packaging
  102.  
  103.  
  104. ΓòÉΓòÉΓòÉ 7. Keywords for General Install Object Information ΓòÉΓòÉΓòÉ
  105.  
  106. The following keywords are for general Install Object information: 
  107.  
  108. TopObjectID=
  109. TargetFolder=
  110.  
  111. Mode= Development
  112.       User
  113.  
  114. Selection=0  No
  115.           1  Yes
  116.  
  117. ObjectType= Install
  118.             Inventory
  119.  
  120.  
  121. ΓòÉΓòÉΓòÉ 8. Keywords for Settings notebook Information Page 1 ΓòÉΓòÉΓòÉ
  122.  
  123. The following keywords are for the Settings notebook Information Page 1: 
  124.  
  125. PackageTitle=
  126. CompanyName=
  127. VersionNumber=
  128. VersionDate=
  129. FeatureID=
  130.  
  131.  
  132. ΓòÉΓòÉΓòÉ 9. Keywords for Settings notebook Information Page 2 ΓòÉΓòÉΓòÉ
  133.  
  134. The following keywords are for the Settings notebook Information Page 2: 
  135.  
  136. HiddenFeature=0   No
  137.               1   Yes
  138. CatalogPath=
  139. CatalogID=
  140. UserHelpPath=
  141.  
  142.  
  143. ΓòÉΓòÉΓòÉ 10. Keywords for Settings notebook Dependencies Page ΓòÉΓòÉΓòÉ
  144.  
  145. The following keywords are for the Settings notebook Dependencies page. 
  146. Dependencies are entered into the Dependency[] array, with each index in the 
  147. array representing a dependency entry in the Setttings notebook. 
  148.  
  149. Dependency[0].FeatureID=
  150. Dependency[0].Setting=
  151. Dependency[0].Value=
  152. Dependency[0].WhenFeatureID=
  153. Dependency[0].ActionFeatureID=
  154. Dependency[0].ActionVariable=
  155. Dependency[0].ActionValue=
  156. Dependency[0].ActionText=
  157. Dependency[0].Condition=0   Exists
  158.                         1   Doesn'tExist
  159.                         2   IsSelected
  160.                         3   IsNotSelectd
  161.                         4   Equal
  162.                         5   NotEqual
  163.                         6   LessThan
  164.                         7   LessOrEqual
  165.                         8   GreaterThan
  166.                         9   GreaterOrEqual
  167.                        10   Contains
  168.                        11   IsPartOf
  169.  
  170. Dependency[0].ResolveTime=0 Selected
  171.                           1 Deselected
  172.                           2 Installed
  173.                           3 Uninstalled
  174.  
  175. Dependency[0].Action=0      SelectFeature
  176.                      1      DeselectFeature
  177.                      2      UninstallFeature
  178.                      3      DisplayWarning
  179.                      4      DisplayError
  180.                      5      SetVariable
  181.                      6      EnableFeature
  182.                      7      DisableFeature
  183. DependencyCount=0
  184.  
  185.  
  186. ΓòÉΓòÉΓòÉ 11. Keywords for Settings notebook Variables Page ΓòÉΓòÉΓòÉ
  187.  
  188. The following keywords are for the Settings notebook Variables page. Variables 
  189. are entered into the Variable[] array, with each index in the array 
  190. representing a variable entry in the Setttings notebook. 
  191.  
  192. Variable[0].Name=
  193. Variable[0].Description=
  194. Variable[0].Value=
  195. Variable[0].ValidationExit.ExitType=0   DLL
  196.                                     1   EXE
  197.                                     2   CMD
  198.  
  199. Variable[0].ValidationExit.DLLName=
  200. Variable[0].ValidationExit.DLLProcName=
  201. Variable[0].ValidationExit.DLLStackSize=8   (8 - 64000)
  202. Variable[0].ValidationExit.EXEFilePath=
  203. Variable[0].ValidationExit.EXEParms=
  204. Variable[0].ValidationExit.EXEPassHandle=0  No
  205.                                          1  Yes
  206. Variable[0].ValidationExit.CMDFilePath=
  207. Variable[0].ValidationExit.CMDParms=
  208. Variable[0].ValidationExit.CMDPassHandle=0  No
  209.                                          1  Yes
  210.  
  211.  
  212. Variable[0].ResolutionExit.ExitType=0   DLL
  213.                                     1   EXE
  214.                                     2   CMD
  215. Variable[0].ResolutionExit.DLLName=
  216. Variable[0].ResolutionExit.DLLProcName=
  217. Variable[0].ResolutionExit.DLLStackSize=8   (8 - 64000)
  218. Variable[0].ResolutionExit.EXEFilePath=
  219. Variable[0].ResolutionExit.EXEParms=
  220. Variable[0].ResolutionExit.EXEPassHandle=0  No
  221.                                          1  Yes
  222. Variable[0].ResolutionExit.CMDFilePath=
  223. Variable[0].ResolutionExit.CMDParms=
  224. Variable[0].ResolutionExit.CMDPassHandle=0  No
  225.                                          1  Yes
  226.  
  227. Variable[0].Required=0   No
  228.                      1   Yes
  229. Variable[0].AlwaysPrompt=1
  230. Variable[0].AlwaysPrompt=0   No
  231.                          1   Yes
  232. Variable[0].DisplayInOptions=0   No
  233.                              1   Yes
  234.  
  235. VariableCount=0
  236.  
  237.  
  238. ΓòÉΓòÉΓòÉ 12. Keywords for Settings notebook User Exits Page ΓòÉΓòÉΓòÉ
  239.  
  240. The following keywords are for the Settings notebook User Exits page. User 
  241. Exits are entered into the UserExits[] array, with each index in the array 
  242. representing a User Exit entry in the Setttings notebook. 
  243.  
  244. UserExits[0].DLLName=
  245. UserExits[0].DLLProcName=
  246. UserExits[0].EXEFilePath=
  247. UserExits[0].EXEParms=
  248. UserExits[0].CMDFilePath=
  249. UserExits[0].CMDParms=
  250. UserExits[0].CallTime=0   AfterAwakening
  251.                       1   ReplaceOptionsDialog
  252.                       2   BeforeInstall
  253.                       3   BeforeFileTransfer
  254.                       4   AfterFileTransfer
  255.                       5   BeforeConfiguration
  256.                       6   AfterConfiguration
  257.                       7   BeforeObjectCreation
  258.                       8   AfterObjectCreation
  259.                       9   AfterInstall
  260.                      10   BeforeUninstall
  261.                      11   BeforeFileDeletion
  262.                      12   AfterFileDeletion
  263.                      13   BeforeConfigurationEntryRemoval
  264.                      14   AfterConfigurationEntryRemoval
  265.                      15   BeforeObjectDeletion
  266.                      16   AfterObjectDeletion
  267.                      17   AfterUninstall
  268.  
  269. UserExits[0].ExitType=0   DLL
  270.                       1   EXE
  271.                       2   CMD
  272.  
  273. UserExits[0].DLLStackSize=8   (8 - 64000)
  274. UserExits[0].EXEPassHandle=0  No
  275.                            1  Yes
  276. UserExits[0].CMDPassHandle=0  No
  277.                            1  Yes
  278.  
  279. UserExitsCount=0
  280.  
  281.  
  282. ΓòÉΓòÉΓòÉ 13. Keywords for Settings notebook Objects Page 1 ΓòÉΓòÉΓòÉ
  283.  
  284. The following keywords are for the Settings notebook Objects page 1. Objects 
  285. are entered into the ObjectCreation[] array, with each index in the array 
  286. representing an object entry in the Setttings notebook. 
  287.  
  288. ObjectCreation[0].ClassName=
  289. ObjectCreation[0].Title=
  290. ObjectCreation[0].SetupString=
  291. ObjectCreation[0].Location=
  292. ObjectCreation[0].Flags=0  FailIfExists
  293.                         1  ReplaceIfExists
  294.                         2  UpdateIfExists
  295.  
  296. CreateObjectCount=0
  297.  
  298.  
  299. ΓòÉΓòÉΓòÉ 14. Keywords for Settings notebook Objects Page 2 ΓòÉΓòÉΓòÉ
  300.  
  301. The following keywords are for the Settings notebook Objects page 2. Class 
  302. registrations are entered into the ClassRegistration[] array, with each index 
  303. in the array representing a class registration entry in the Setttings notebook. 
  304.  
  305. ClassRegistration[0].ClassName=
  306. ClassRegistration[0].DLLName=
  307.  
  308. RegisterCount=0
  309.  
  310.  
  311. ΓòÉΓòÉΓòÉ 15. Keywords for Settings notebook Media Page ΓòÉΓòÉΓòÉ
  312.  
  313. The following keywords are for the Settings notebook Media page. Media Sets are 
  314. entered into the MediaSet[] array, with each index in the array representing a 
  315. Media Set entry in the Setttings notebook. 
  316.  
  317. MediaSet[0].SetName=
  318. MediaSet[0].MediaCount=
  319. MediaSet[0].Media[0].Description=
  320. MediaSet[0].Media[0].MediaPath=
  321. MediaSet[0].Media[0].NetName=
  322. MediaSet[0].Media[0].Type=1    Diskette
  323.                           2    CDROM
  324.                           4    LogicalDisk
  325.  
  326. MediaSet[0].Media[0].SubType=1 360KB
  327.                              2 720KB
  328.                              4 1.2MB
  329.                              8 1.44MB
  330.                             16 2.88MB
  331.                             32 UserDefinedCapacity
  332. MediaSet[0].Media[0].Capacity=
  333. MediaSet[0].Media[0].ReservedSpace=
  334. MediaSet[0].Media[0].Flags=
  335. MediaSetCount=
  336.  
  337.  
  338. ΓòÉΓòÉΓòÉ 16. Keywords for Settings notebook File List Page ΓòÉΓòÉΓòÉ
  339.  
  340. The following keywords are for the Settings notebook File List page. File 
  341. entries are entered into the File[] array, with each index in the array 
  342. representing a File entry in the Setttings notebook. 
  343.  
  344. File[0].Source=
  345. File[0].Source Path=
  346. File[0].SourceFileName=
  347. File[0].SourceChecksum=
  348. File[0].SourceEASize=
  349. File[0].CreationDate=
  350. File[0].CreationTime=
  351. File[0].LastAccessDate=
  352. File[0].LastAccessTime=
  353. File[0].LastWriteDate=
  354. File[0].LastWriteTime=
  355. File[0].CBFile=
  356. File[0].CBFileAlloc=
  357. File[0].AttrFile=
  358. File[0].Target Path=
  359. File[0].TargetFileName=
  360. File[0].MediaPath=
  361. File[0].MediaFileName=
  362. File[0].MediaNumber=
  363. File[0].CompressionID=
  364. File[0].Flags=
  365. File[0].TargetAttrib=
  366. File[0].PartCount=
  367. File[0].EAFileSpec=
  368. File[0].EAMediaIndex=
  369. File[0].PartSize=
  370. File[0].MediaIndex=
  371. File[0].RestrCount=
  372.  
  373. FileCount=0
  374.  
  375.  
  376. ΓòÉΓòÉΓòÉ 17. Keywords for Settings notebook Compression Page ΓòÉΓòÉΓòÉ
  377.  
  378. The following keywords are for the Settings notebook Compression page. 
  379. Compression entries are entered into the Compression[] array, with each index 
  380. in the array representing a Compression entry in the Setttings notebook. 
  381.  
  382. Compression[0].Description=
  383. Compression[0].CompCmdLine=
  384. Compression[0].CompSupportsEAs=0     No
  385.                                1     Yes
  386. Compression[0].CompInPlace=0         No
  387.                            1         Yes
  388. Compression[0].DecompCmdLine=
  389. Compression[0].DecompSupportsEAs=0   No
  390.                                  1   Yes
  391. Compression[0].DecompInPlace=0       No
  392.                              1       Yes
  393. Compression[0].UseCount=0
  394.  
  395. ComprCount=0
  396.  
  397.  
  398. ΓòÉΓòÉΓòÉ 18. Keywords for Settings notebook Configure Page 1 ΓòÉΓòÉΓòÉ
  399.  
  400. The following keywords are for the Settings notebook Configure page 1. ASCII 
  401. File entries are entered into the AsciiFile[] array, with each index in the 
  402. array representing an ASCII File entry in the Setttings notebook. 
  403.  
  404. AsciiFile[0].FileName=
  405. AsciiFile[0].EditLine=
  406. AsciiFile[0].SearchLine=
  407. AsciiFile[0].NewLine=
  408. AsciiFile[0].AddBeforeLine=
  409. AsciiFile[0].AddAfterLine=
  410. AsciiFile[0].UnBeforeLine=
  411. AsciiFile[0].UnAfterLine=
  412. AsciiFile[0].Delimiter=
  413. AsciiFile[0].SubstrChk=0      No
  414.                        1      Yes
  415. AsciiFile[0].DelimChk=0       No
  416.                       1       Yes
  417. AsciiFile[0].Action=0         Replace
  418.                     1         Edit
  419.  
  420. AsciiFile[0].EditLineOcc=0    FirstOccurrence
  421.                          1    LastOccurrence
  422.                          2    EveryOccurrence
  423.  
  424. AsciiFile[0].SrcLineOcc=0     FirstOccurrence
  425.                         1     LastOccurrence
  426.                         2     EveryOccurrence
  427.  
  428. AsciiFile[0].AddBLineOcc=0    FirstOccurrence
  429.                          1    LastOccurrence
  430.  
  431. AsciiFile[0].AddALineOcc=0    FirstOccurrence
  432.                          1    LastOccurrence
  433.  
  434.  
  435. AsciiFile[0].SearchFound=1     ReplaceLine
  436.                          2     TakeNoAction
  437.  
  438. AsciiFile[0].SearchNotFound=1   AddLineToBeginning
  439.                             2   AddLineToEnd
  440.                             4   AddLineRelative
  441.                             8   TakeNoAction
  442.  
  443. AsciiFile[0].MatchPosition=1   AddIfMatchFound
  444.                            2   NoActionIfMatchFound
  445.  
  446. AsciiFile[0].NoMatchPosition=1  AddToBeginningOfFile
  447.                              2  AddToEndOfFile
  448.                              8  TakeNoAction
  449.  
  450. CfgCount=0
  451.  
  452.  
  453. ΓòÉΓòÉΓòÉ 19. Keywords for Settings notebook Configure Page 2 ΓòÉΓòÉΓòÉ
  454.  
  455. The following keywords are for the Settings notebook Configure page 2. OS/2 INI 
  456. Files are entered into the Os2PrfIni[] array, with each index in the array 
  457. representing an OS/2 INI File entry in the Setttings notebook. 
  458.  
  459. Os2PrfIni[0].FileName=
  460. Os2PrfIni[0].Application=
  461. Os2PrfIni[0].Key=
  462. Os2PrfIni[0].Value=
  463. Os2PrfIni[0].IniType=1      OS/2 Type Ini
  464.                      2      Win/OS2 Type Ini
  465.  
  466. Os2PrfIniCount=0
  467.  
  468.  
  469. ΓòÉΓòÉΓòÉ 20. Keywords for Settings notebook Configure Page 3 ΓòÉΓòÉΓòÉ
  470.  
  471. The following keywords are for the Settings notebook Configure page 3. WIN INI 
  472. Files are entered into the WinOs2Ini[] array, with each index in the array 
  473. representing a WIN INI File entry in the Setttings notebook. 
  474.  
  475. WinOs2Ini[0].FileName=
  476. WinOs2Ini[0].Application=
  477. WinOs2Ini[0].Key=
  478. WinOs2Ini[0].Value=
  479. WinOs2Ini[0].IniType=1       OS/2 Type Ini
  480.                      2       Win/OS2 Type Ini
  481.  
  482. WinOs2IniCount=0
  483.  
  484.  
  485. ΓòÉΓòÉΓòÉ 21. Keywords for Packaging ΓòÉΓòÉΓòÉ
  486.  
  487. The following keywords are for Packaging: 
  488.  
  489. MediaSetIndex=
  490. FilesDone=
  491. TotalFiles=
  492. ProductID=
  493. FirstSerialNum=
  494. PackageFlags=
  495. TotalMediaUsed=
  496.