| SoapEnvelope Properties |
| AutoProcess |
Syntax
objSoapEnvelope.AutoProcess [= Boolean]
Description
If AutoProcess is set to True, FileUpEE
will process the Request according to the SOAP payload (the XML document
tranferred with a SOAP request), and processing insructions (such as a Save
statement) are not required in the script that contains the
ProcessRequest statement.
When AutoProcess is set to True, the SOAP payload must contain
all necessary information to process the Request. For example, when uploading
from a Web server to a file server, if AutoProcess is set to True
in the file server script, the Web server script must contain all file server
instructions. The instructions will be executed automatically on the file
server.
If AutoProcess is set to False, FileUpEE will process the
Request according to your script. In this case, include all processing
instructions (such as database information) in your script.
AutoProcess is a Read/Write property.
Top |
| BufferSize |
Syntax
objSoapEnvelope.BufferSize [= Buffer Size in Bytes]
Description
When transferring files from server to server,
FileUpEE will fill the input data into an internal buffer.
BufferSize specifies the size in bytes of the internal buffer. If
the file transfer is larger than BufferSize, FileUpEE
will discard excess data; only data up to the size of the buffer will be
transferred.
BufferSize is a Read/Write property. The default
BufferSize is 64512 bytes.
Top |
| ContentType |
Syntax
objSoapEnvelope.ContentType [= MIME Content-Type as
String]
Description
ContentType specifies the transferred data's
MIME content type (e.g., text/plain, application/msword, image/jpeg, application/pdf).
ContentType is a Read/Write property.
Top |
| DbPrimaryKey |
Syntax
objSoapEnvelope.DbPrimaryKey [= Primary Key Column Name]
Description
When transferring files to a
database, to update a row, use DbPrimaryKey to specify the table's
primary key column name.
DbPrimaryKey is a Read/Write property.
To update a database row, you must set DbPrimaryKey, DbPrimaryKeyValue, and DbSqlCommand. Do not set these values to add a
row.
Top |
| DbPrimaryKeyValue |
Syntax
objSoapEnvelope.DbPrimaryKeyValue [= Primary Key Value]
Description
DbPrimaryKeyValue sets or returns
a database record's primary key value.
When uploading a file to a database, to update a row, you must
set DbPrimaryKeyValue, DbPrimaryKey,
and DbSqlCommand. Do not set these values to
add a row.
When downloading a file from database, you must set
DbPrimaryKeyValue for the record containing the file.
DbPrimaryKeyValue is a Read/Write property.
Top |
| DbSqlCommand |
Syntax
objSoapEnvelope.DbSqlCommand [= SQL Query]
Description
When transferring files to a database, to
update a row, set DbSqlCommand to a SQL query that specifies
the row to update. DbSqlCommand is a Read/Write
property.
To update a database row, you must set DbSqlCommand, DbPrimaryKey, and DbPrimaryKeyValue. Do not set these values to
add a row.
Top |
| DestinationDirectory |
Syntax
objSoapEnvelope.DestinationDirectory [= Directory Path]
Description
To save all files in an upload to one
directory, set DestinationDirectory to the destination directory path.
DestinationDirectory is a Read/Write property.
Top |
| Files |
Syntax
FileCollection = objSoapEnvelope.Files
Description
Files returns the collection of files in an
upload.
Files is a Read Only property.
Top |
| Header |
Syntax
SoapHeaders = objSoapEnvelope.Header
Description
Returns the collection of
SoapHeaders in the SOAP request.
Top |
| MaxKBytes |
Syntax
objSoapEnvelope.MaxKBytes(SATransferStage) [= Upload size limit in Kilobytes]
Description
MaxKBytes sets a file size limit for an
upload. MaxKBytes is a per-file limit, not a limit for a whole multiple-file
upload. For each file in an upload, FileUpEE will stop writing the file to disk at the value
of MaxKBytes. Note that the incomplete file will be saved.
In a client to Web server to file server upload, you can set two upload size limits: a
limit for the Web server and a limit for the file server. The parameter
SATransferStage specifies whether the size limit is for the Web server or
file server.
When MaxKBytes is set to zero, there is no size limit for
uploaded files. MaxKBytes is set to zero by default.
To take effect, MaxKBytes(saWebServer) must be set before
ProcessRequest is called on the Web server.
MaxKBytes(saFileServer) must be set before
ProcessRequest is called on the file server.
MaxKBytes is a Read/Write property.
Parameter
MaxKBytes takes the parameter SATransferStage which
specifies the stage of the upload: client -> Web server or Web server -> file server.
| SATransferStage Values |
|---|
saWebServer | 1 |
saFileServer | 2 |
Top |
| MaxKBytesToCancel |
Syntax
objSoapEnvelope.MaxKBytesToCancel(SATransferStage) [= File size limit in Kilobytes]
Description
FileUpEE will abort a file upload
when the size of the transfer reaches the value
of MaxKBytesToCancel. No data will be written to the server's hard
disk, the connection will be terminated, and the browser will display a
"Page not found" message.
Setting MaxKBytesToCancel may reduce the threat of a DoS
(Denial of Service) attack on the file server. When an upload size hits
MaxKBytesToCancel, the connection to the server will be terminated,
the ASP page will finish executing, and the ASP thread will be freed.
In a client to Web server to file server upload, you can set one of two upload size
limits: a limit for the Web server or a limit for the file server. The parameter
SATransferStage specifies whether the size limit is for the Web server or
file server.
To take effect, MaxKBytesToCancel(saWebServer) must be set before
ProcessRequest is called on the Web server.
MaxKBytesToCancel(saFileServer) must be set before
ProcessRequest is called on the file server.
MaxKBytesToCancel is a Read/Write property.
Parameter
MaxKBytesToCancel takes the parameter SATransferStage which
specifies the stage of the upload: client -> Web server or Web server -> file server.
| SATransferStage Values |
|---|
saWebServer | 1 |
saFileServer | 2 |
Top |
| Namespaces |
Syntax
objSoapEnvelope.Namespaces
Description
Namespaces returns the collection of
name/value namespaces in the SOAP message.
Namespaces is a Read only property.
Top |
| Param |
Syntax
objSoapEnvelope.Param [= Param Value]
Description
Param sets or returns the value of a custom
name/value parameter sent in the SOAP request.
Param is a Read/Write property.
Top |
| ParamName |
Syntax
objSoapEnvelope.ParamName [= Param Name]
Description
ParamName sets or returns the name of a custom
name/value parameter sent in the SOAP request.
ParamName is a Read/Write property.
Top |
| PreserveMacBinary |
Syntax
objFileUpEE.PreserveMacBinary [= Boolean]
Description
If PreserveMacBinary is set to True, files uploaded from a
Macintosh will be saved in MacBinary format. If this property is set to False,
the data fork will be extracted and saved as the uploaded file. PreserveMacBinary
is set to False by default.
PreserveMacBinary is a Read/Write property.
Top |
| Result |
Syntax
saResult = objSoapEnvelope.Processed
Description
Returns the status of a SOAP transfer as an
saResult.
Result is a Read only property.
Return Value
| saResult Values |
saAllProcessed |
0 |
All files were processed without error. |
NotesaResult values specify whether or not files were
processed correctly, not whether they were saved. If, for example, an uploaded
file is not saved because FileEE.OverwriteFile is disabled, the
file was processed without error. |
saSomeProcessed |
1 |
Errors occurred when processing one or more files. Some files were processed
without error. |
saNoneProcessed |
2 |
Errors occurred when processing all files. |
Top |
| TempStorageLocation |
Syntax
objSoapEnvelope.WsTempStorageLocation [= Web Server Temp
Directory]
Description
When an upload reaches the Web server, it
is cached. WsTempStorageLocation sets the cache directory on the
Web server. If you do not assign a value to WsTempStorageLocation,
uploads will be cached in the system's default directory for cached files,
typically c:\winnt\temp.
Set WsTempStorageLocation before the ProcessRequest statement.
WsTempStorageLocation is a Read/Write property.
Note
To change the system's default directory for cached files, reset the TEMP
environment variable, as follows:
- Open the Control Panel.
- Select System.
- Select the Advanced tab.
- Click Environment variables...
- Select TEMP from the System Variables list.
- Click Edit.
- Enter a new Variable Value, and click Ok.
Example
objSoapEnvelope.WsTempStorageLocation = "c:\upload\temp" Top |
| UseChecksum |
Syntax
objSoapEnvelope.UseChecksum [= Boolean]
Description
UseChecksum allows you to verify the
integrity of data uploaded from Web server to file server. If UseChecksum
is set to True on the Web server, FileUpEE
will generate a file content checksum for the upload and send the checksum with the
upload to the file server. On the file server, use
FileUpEE.ValidateChecksums to
verify that the data was not corrupted during transfer.
UseChecksum is a Read/Write property.
See Also
You can generate and validate a content checksum for an upload or for a single
file in the upload. For information on using per-file checksums, see
FileEE.Checksum,
FileEE.ContentChecksum,
FileEE.UseChecksum, and
FileEE.ValidateChecksum.
For more information on using per-upload checksums, see
FileUpEE.UseChecksum and
FileUpEE.ValidateChecksums.
Top |
| UseMemory |
Syntax
objSoapEnvelope.UseMemory(SATransferStage) [= Boolean]
Description
If UseMemory is set to True,
FileUpEE will store data uploaded to the specified server in memory until the data is
saved. If UseMemory is set to False,
data uploaded to the specified server will be cached in a temporary directory until it
is saved. UseMemory is set to False
by default.
Caching files in memory can increase the speed of uploads. However,
before setting UseMemory to True you should consider other factors
affecting the upload, such as, available memory on the file server,
how active the server is, and the size of the upload.
To take effect, UseMemory(saWebServer) must be set before
ProcessRequest is called on the Web server.
UseMemory(saFileServer) must be set before
ProcessRequest is called on the File server.
UseMemory is a Read/Write property.
Parameter
UseMemory takes the parameter SATransferStage which
specifies whether to cache in memory on the Web server or file server. Note that FileUpEE
will cache files on both the Web server and the file server.
| SATransferStage Values |
|---|
saWebServer | 1 |
saFileServer | 2 |
Example
objSoapEnvelope.UseMemory(saWebServer) = True
Top |
| Xml |
Syntax
objSoapEnvelope.Xml
Description
Returns the values set in the XML file containing the
SOAP message.
Xml is a Read Only property.
Example
...
objFileUpEE.SendRequest()
Response.Write objFileUpEE.SoapEnvelope.Xml
...
Top |