xmanual.htm

aspupload

<td>Returns a string representing the current version of this control, for example
"2.1.0.0".</td>
</tr>


</table>

<p><b><u>XUpload Methods</u></b>
<table BORDER CELLSPACING=0 COLS=3 WIDTH="91%" >
<tr VALIGN=TOP BGCOLOR="#CCFFFF">
<td><b>Method&nbsp; Name</b></td>

<td NOWRAP><b>Arguments</b></td>

<td><b>Comments</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>Upload</b></td>

<td>N/A</td>

<td>Has the same effect as choosing "Upload" from the popup menu. Causes
the upload process to begin.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Select</b></td>

<td>N/A</td>

<td>Has the same effect as choosing "Select" from the popup menu. Causes
the Select Files dialog to come up.
<p>This method must not be called if XUpload is used as a server component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>SelectFolder</b></td>

<td>N/A</td>

<td>Has the same effect as choosing "Select Folder" from the popup menu.
Causes the Select Folder dialog to come up.
<p>This method must not be called if XUpload is used as a server component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Remove</b></td>

<td>Index As Integer</td>

<td>Removes a file with the zero-based index specified by
<b>Index</b>
from the file list.
<p>This method must not be called if XUpload is used as a server component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>RemoveHighlighted</b></td>

<td>N/A</td>

<td>Has the same effect as choosing "Remove" from the popup menu. Causes
all highlighted items on the file list to be removed.
<p>This method must not be called if XUpload is used as a server component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>RemoveAll</b></td>

<td>N/A</td>

<td>Invokes the Remove All command. Clears the file list.</td>
</tr>

<tr VALIGN=TOP>
<td><b>AddFile</b></td>

<td>Path As String</td>

<td>Adds a new file to the file list.</td>
</tr>

<tr VALIGN=TOP>
<td><b>AddFolder</b></td>

<td NOWRAP>Path As String
<br>Optional Recursive = False</td>

<td>Adds all files contained in <i>Folder</i> to the file list. If <i>Recursive</i>
is set to True, also adds all files in sub-folders recursively.</td>
</tr>

<tr VALIGN=TOP>
<td><b>DisplayProperties</b></td>

<td>N/A</td>

<td>Causes the XUpload property sheet to come up.&nbsp;
<p>This method must not be called if XUpload is used as a server component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Stop</b></td>

<td>N/A</td>

<td>Programmatically stops an upload. Calling this method is equivalent
to pressing the Stop button on the progress bar.</td>
</tr>

<tr VALIGN=TOP>
<td><b>AddFormItem</b></td>

<td>Name As String
<br>Value As String</td>

<td>Use this method to simulate non-file form items for an upload. See
file <i>FormItems.htm</i> for code sample.</td>
</tr>

<tr VALIGN=TOP>
<td><b>RemoveAllFormItems</b></td>

<td>N/A</td>

<td>Removes all items added by <b>AddFormItem</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>AddCookie</b></td>

<td>URL As String
<br>Name As String
<br>Data As String</td>

<td>Creates a cookie associated with the specified <i>URL</i>. <i>Name</i>
is a string that contains the name to associate with the cookie data. If
this parameter is empty, no name is associated with the cookie. <i>Data</i>
is the actual data to associate with the URL.</td>
</tr>

<tr VALIGN=TOP>
<td><b>MakeHttpRequest</b></td>

<td NOWRAP>Method As String
<br>Params As String
<br>Optional Path = ""
<br>Optional UserAgent = "XUpload"
<br>Optional Headers = ""
<p>Returns: String</td>

<td>Performs an HTTP request using the properties Server, Script, Port,
Username and Password. <b>Method</b> specifies the request type such as
"GET" or "POST". <b>Params</b> specify the data to be sent to the server.
Leave this parameter empty if <b>Method</b> is "GET". <b>Path</b>, if not
empty, instructs the method to save the output in a file. <b>UserAgent</b>
and <b>Headers</b>, if not empty, specify additional information to be
sent to the server.
<p>Returns the output received from the server.</td>
</tr>
</table>

<p><b><u>XUpload Events</u></b>
<table BORDER CELLSPACING=0 CELLPADDING=2 COLS=3 WIDTH="93%" >
<tr VALIGN=TOP BGCOLOR="#99FF99">
<td><b>Name</b></td>

<td><b>Arguments</b></td>

<td><b>Comments</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>Sort</b></td>

<td>Column As Integer</td>

<td>Fired when the file list is sorted. If <b>Column</b> is 0 the sorting
is by File name, otherwise the sorting is by size.</td>
</tr>

<tr VALIGN=TOP>
<td><b>AddFiles</b></td>

<td>Number As Integer,
<br>Size As Long</td>

<td>Fires when files are added to the file list. <b>Number</b> specifies
the number of files being added, <b>Size</b> specifies total size.&nbsp;</td>
</tr>

<tr VALIGN=TOP>
<td><b>RemoveFiles</b></td>

<td>Number As Integer,
<br>Size As Long</td>

<td>Fires when files are removed from the file list. <b>Number</b> specifies
the number of files being removed, <b>Size</b> specifies total size.</td>
</tr>

<tr VALIGN=TOP>
<td><b>UploadStart</b></td>

<td>N/A</td>

<td>Fires when the upload process starts.</td>
</tr>

<tr VALIGN=TOP>
<td><b>UploadFinish</b></td>

<td>N/A</td>

<td>Fires when the upload process ends, but before a reply from the server
is received.</td>
</tr>

<tr VALIGN=TOP>
<td><b>UploadProgress</b></td>

<td>FilePercent As Integer,
<br>OverallPercent As Integer</td>

<td>Fires to indicate the upload progress. <b>FilePercent</b> is an integer
between 0 and 100 that specifies the progress of an individual file. <b>OverallPercent</b>
is a integer between 0 and 100 that specifies the overall progress.</td>
</tr>

<tr VALIGN=TOP>
<td><b>WaitingForReply</b></td>

<td>N/A</td>

<td>Fires right after all files are uploaded but before a reply from the
server is received.</td>
</tr>

<tr VALIGN=TOP>
<td><b>UploadFile</b></td>

<td>FileName As String</td>

<td>Fires right after a file is opened to be uploaded. <b>FileName</b>
specifies the file's full path.</td>
</tr>

<tr VALIGN=TOP>
<td><b>ServerReply</b></td>

<td>Reply As String</td>

<td>Fires when a reply is received from the server. <b>Reply</b> specifies
the text received.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Error</b></td>

<td NOWRAP>Code As Long,&nbsp;
<br>Description As String</td>

<td>Fires when an error occurs. <b>Code</b> can be one of the following
values:
<p>1 - Too many files selected by Select Files dialog.
<br>2 - Selecting files failed.
<br>3 - Server not specified.
<br>4 - Script not specified.
<br>5 - Opening HTTP session failed.
<br>6 - Error connecting to the server.
<br>7 - Opening HTTP request failed.
<br>8 - Wrong file extension.
<br>9&nbsp; - Cannot open file.
<br>10 - Sending HTTP request failed.
<br>11 - Cannot open file during uploading.
<br>12 - Error reading file.
<br>13 - Error sending data.
<br>14 - File number exceeds MaxFileCount.
<br>15 - Reserved.
<br>16 - File size exceeds MaxFileSize.
<br>17 - Total file size exceeds MaxTotalSize.
<br>18 - Control expired.</td>
</tr>
</table>
</blockquote>


<font color="#000099"><B>Common WinInet Errors and Trouble-shooting</B></font>

<blockquote>Error: <b>12029</b>
<br>Meaning: "Cannot connect."
<br>Solution: Make sure the Server and Script parameters are correct and
the network connection is functioning.
<p>Error: <b>12030</b>
<br>Meaning: "Connection Aborted."
<br>Solution: This error usually means that XUpload's SSL parameter does
match the SSL settings of the server. Check whether the server requires
an SSL connection, and if so set the SSL property to True. This error may
also mean that the specified script cannot be found on the server.
<P>
For more technical support information, visit our searchable database
of articles at <A HREF="http://support.persits.com"><B>SUPPORT.PERSITS.COM</B></A>.

</blockquote>


<font color="#000099"><B>Where to Get Help</B></font>

<blockquote><font color="#000000">For more information on XUpload, including
licensing, please visit the web site <b><a href="http://www.aspupload.com">www.aspupload.com</a></b>.
For general and sales info, please write to <a href="mailto:[e-mail]">[e-mail]</a>.
For technical support, please write to <a href="mailto:[e-mail]">[e-mail]</a>.</font></blockquote>



</TD></TR>
</TABLE>

</basefont>
</body>
</html>