Search: 
Available in: IP*WORKS!
Webupload Class
WebUpload Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

To use the component 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 component with short descriptions. Click on the links for complete descriptions.

Accept A list of acceptable MIME types for the request.
AuthScheme The authorization scheme to be used when server authorization is to be performed.
Connected Shows whether the component is connected.
ContentType Content type for posted data.
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. (optional)
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 retrieval.
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 transfer.
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 component with short descriptions. Click on the links for complete descriptions.

AddCookie Sets a cookie and the corresponding value.
AddFileVar Adds a file variable and the corresponding file name.
AddFormVar Adds a form variable and the corresponding value.
Config Sets or retrieves a component 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 component with short descriptions. Click on the links for complete descriptions.

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 .

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression This property enables HTTP compression for receiving data.
Authorization The Authorization string to be sent to the server.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxHTTPCookies Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme The authorization scheme to be used for the proxy.
ProxyAuthorization The authorization string to be sent to the proxy server.
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.
SocketHandle The handle of the main socket used by the component.
TcpNoDelay Whether or not to delay when sending packets
TransferredDataLimit The maximum number of incoming bytes to be stored by the component.
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.