Search: 
Available in: IP*WORKS! | SSH | SSL
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 properties and optional form variables in the FormVars properties .

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 further details.

AcceptA list of acceptable MIME types for the request.
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
ConnectedShows whether the component is connected.
ContentTypeContent type for posts and puts.
CookiesCollection of cookies.
FileVarsFile variables for the current request.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
FormVarsForm variables for the current request.
FromThe email address of the HTTP agent (optional).
IdleThe current status of the component.
LocalFileThe path to a local file for downloading. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeadersCollection of headers returned from the last request.
PasswordA password if authentication is to be used.
ProxyA set of properties related to proxy access.
RefererReferer URL/document (optional).
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
URLThe URL to post information to.
UserA 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 further details.

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AddFileVarAdds a file variable and the corresponding file name.
AddFormVarAdds a form variable and the corresponding value.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ResetReset the component.
UploadPosts data to the URL specified by URL .
UploadToPosts 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 further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).
UploadProgressFired while the component is uploading files to the URL .

Configuration Settings


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

AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AuthorizationThe Authorization string to be sent to the server.
EncodeURLIf set to true the URL will be encoded by the component.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after the completion of the request.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
UserAgentInformation about the user agent (browser).
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
TcpNoDelayWhether or not to delay when sending packets
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only).

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