main_tcabfile.htm

   1 <html>
   2 <head>
   3 <title>KOL Help: TCABFile object (main frame)</title>
   4 <base target="_top">
   5 </head>
   6
   7 <body bgcolor="#FFFFEF" text="#000000" link="#008080" vlink="#008000" alink="#808000">
   8 <p><font face="Courier" color="#800080"><b>TCABFile( unit <a href=kol_pas.htm>KOL.pas</a> )
   9  <font face="Wingdings">ï</font> <a href=tobj.htm>TObj</a>
  10  <font face="Wingdings">ï</font> <a href=_tobj.htm>_TObj</a>
  11 </b></font></p>
  12 <p><b>
  13 TCABFile = object( <a href=tobj.htm target="_top">TObj</a> )
  14 </b></p>
  15 An object to simplify extracting files from a cabinet (.CAB) files.
  16 The only what need to use this object, setupapi.dll. It is provided
  17 with all latest versions of Windows.
  18 <h3 align="center"><font color="#FF8080">TCABFile properties</font></h3>
  19 <a name="paths"></a>
  20 <p>
  21 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Paths</b></font>[ Idx: <b>Integer</b> ]: <b>String</b>;</font>
  22 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
  23 <br>
  24 A list of CAB-files. It is stored, when constructing function
  25 <a href=kol_pas.htm#opencabfile target="_top">OpenCABFile</a> called.
  26 </p>
  27 <a name="names"></a>
  28 <p>
  29 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Names</b></font>[ Idx: <b>Integer</b> ]: <b>String</b>;</font>
  30 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
  31 <br>
  32 A list of file names, stored in a sequence of CAB files. To get know,
  33 how many files are there, check <a href=#count target="main">Count</a> property.
  34 </p>
  35 <a name="count"></a>
  36 <p>
  37 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Count</b></font>: <b>Integer</b>;</font>
  38 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
  39 <br>
  40 Number of files stored in a sequence of CAB files.
  41 </p>
  42 <a name="curcab"></a>
  43 <p>
  44 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>CurCAB</b></font>: <b>Integer</b>;</font>
  45 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
  46 <br>
  47 Index of current CAB file in a sequence of CAB files. When <a href=#onnextcab target="main">OnNextCAB</a>
  48 event is called (if any), CurCAB property is already set to the
  49 index of path, what should be provided.
  50 </p>
  51 <a name="targetpath"></a>
  52 <p>
  53 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>TargetPath</b></font>: <b>String</b>;</font>
  54 <br>
  55 Optional target directory to place there extracted files.
  56 </p>
  57 <h4 align="center"><font color="black">Properties, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
  58 <h3 align="center"><font color="#FF8080">TCABFile methods</font></h3>
  59 <a name="destroy"></a>
  60 <p>
  61 <font face="Courier" color="#800080"><b>destructor</b> <font color="#808000"><b>Destroy</b></font>; <b>virtual</b>;</font>
  62 <br>
  63 </p>
  64 <a name="execute"></a>
  65 <p>
  66 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>Execute</b></font>: <b>Boolean</b>;</font>
  67 <br>
  68 Call this method to extract or enumerate files in CAB. For every
  69 file, found during executing, event <a href=#onfile target="main">OnFile</a> is alled (if assigned).
  70 If the event handler (if any) does not provide full target path for
  71 a file to extract to, property <a href=#targetpath target="main">TargetPath</a> is applyed (also if it
  72 is assigned), or file is extracted to the default directory (usually
  73 the same directory there CAB file is located, or current directory
  74 - by a decision of the system).
  75 <br>
  76 If a sequence of CAB files is used, and not all names for CAB files
  77 are provided (absent or represented by a string '?' ), an event
  78 <a href=#onnextcab target="main">OnNextCAB</a> is called to obtain the name of the next CAB file.
  79 </p>
  80 <h4 align="center"><font color="black">Methods, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
  81 <h3 align="center"><font color="#FF8080">TCABFile events</font></h3>
  82 <a name="onnextcab"></a>
  83 <p>
  84 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>OnNextCAB</b></font>: TOnNextCAB;</font>
  85 <br>
  86 This event is called, when a series of CAB files is needed and not
  87 all CAB file names are provided (absent or represented by '?' string).
  88 If this event is not assigned, the user is prompted to browse file.
  89 </p>
  90 <a name="onfile"></a>
  91 <p>
  92 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>OnFile</b></font>: TOnCABFile;</font>
  93 <br>
  94 This event is called for every file found during <a href=#execute target="main">Execute</a> method.
  95 In an event handler (if any assigned), it is possible to return
  96 False to skip file, or to provide another full target path for
  97 file to extract it to, then default. If the event is not assigned,
  98 all files are extracted either to default directory, or to the
  99 directory <a href=#targetpath target="main">TargetPath</a>, if it is provided.
 100 </p>
 101 <h4 align="center"><font color="black">Events, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
 102 <h3 align="center"><font color="#FF8080">TCABFile fields</font></h3>
 103 <h4 align="center"><font color="black">Fields, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
 104 <hr>
 105 <p align="center">[&nbsp;<a href=index.htm>Index</a>&nbsp;]</p>
 106 <p align="center"><font face="Comic Sans MS"><small>This help is generated 22-Sep-2005 by KOL Help generator, (C) 2000-2001 by Vladimir Kladov<br>Modified (C) 2003 by Alexander Bartov</small></font></p>
 107 </body>
 108 </html>