WebUpload Bean

Properties Methods Events Configuration Settings Errors

The WebUpload Component is used to upload files to RFC1867-compliant web servers.

Syntax

IPWorks.Webupload

Remarks

To use the bean as a file upload client, provide the file names (paths) in the FileVars collection and optional form variables in the FormVars collection .

Then, set the URL property to the address of the page or script that accepts the files, and call the Upload method. Alternatively you can call the UploadTo method with URL as a parameter.

The UploadProgress event is fired during upload which shows the progress of the upload. The Transfer event shows the server response (normally an HTML page).

Property List

The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.


Accept	A list of acceptable MIME types for the request.
Authorization	The Authorization string to be sent to the server.
AuthScheme	The authentication scheme to use when server authorization is required.
Connected	Shows whether the component is connected.
ContentType	Content type for posts and puts.
Cookies	Collection of cookies.
FileVars	File variables for the current request.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
FormVars	Form variables for the current request.
From	The email address of the HTTP agent (optional).
Idle	The current status of the component.
LocalFile	The path to a local file for downloading. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Password	A password if authentication is to be used.
Proxy	A set of properties related to proxy access.
Referer	Referer URL/document (optional).
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
URL	The URL to post information to.
User	A user name if authentication is to be used.

Method List

The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.


addCookie	Adds a cookie and the corresponding value to the outgoing request headers.
addFileVar	Adds a file variable and the corresponding file name.
addFormVar	Adds a form variable and the corresponding value.
config	Sets or retrieves a configuration setting .
doEvents	Processes events from the internal message queue.
interrupt	Interrupt the current method.
reset	Reset the component.
upload	Posts data to the URL specified by URL .
uploadTo	Posts data to the URL specified by the 'URL' parameter.

Event List

The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).
UploadProgress	Fired while the component is uploading files to the URL .

Configuration Settings

The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.


FileVarContentTransferEncoding[i]	Specifies the Content-Transfer-Encoding header for a file.
FormVarContentType[i]	Specifies the Content-Type header for a Form Variable.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.