1. Home / Web Services API Version 8.x / GetDownloadHandlerByVersion

GetDownloadHandlerByVersion

Returns a document download handler for a specific version of a document

Syntax

Visual Basic (declaration) 
Public Function GetDownloadHandlerByVersion( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal PreferedChunkSize as  Integer, _ 
	ByVal VersionNumber as  Integer) as XmlNode

C# (declaration) 
public XmlNode GetDownloadHandlerByVersion( 
	string AuthenticationTicket,
	string Path,
	integer PreferedChunkSize,
	integer VersionNumber)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string A document path to be downloaded.
PreferedChunkSize
    integer The size of the download chunks in bytes.
VersionNumber
    integer The document version number

Return Value

returns xml fragment.
if success attribute is "true", the download handler and other information has been retrieved successfully like the xml sample below.
if success attribute is "false", the error attribute indicates the encountered error.

    <response success="true" error="" Size="115474" ContentType="application/pdf" ModificationDate="2009-01-30 17:52:02" VersionNumber="1000000" AlterDocumentName="CSharp Coding Standards.pdf" RenderedContent="false" CRC32="D19496AE" ChunkSize="65536" downloadhandler="ir178"/>

Remarks

This method especially usefull in the following conditions;
- The document is relatively bigger than to get in one shot.
- The connection speed of client and server is slow.

Pros over DownloadDocument:
- Allows to the programmers to display a progress while downloading a document.
- Allows to re-retrive a chunk of file if a package has been corrupted on the network.
Cons over DownloadDocument
- More codes to be written
- Going back and forward to the server couple of times takes too much time in small files.


The user must have a least read right or the document must have in a anonymous domain.

See Also