ParcelDownloadReset()


Reset Download of Parcel and restore to InBox.

Public Function ParcelDownloadReset(ByVal SessionID As String, _
                                    
ByVal ParcelID As Long) _
                                    
As Boolean

Parameters

SessionID
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
ParcelID
Long
The value assigned to track a specific Parcel on ECGrid.

Returns

Boolean 
True if successful, false on failure.

Remarks

Once a Parcel has been successfully downloaded from the InBox the first time, ParcelDownloadConfirm() should be called to remove it from the pending download list.

If one desires to reset the download status of a Parcel, then this API should be called. It will reset the status of the Parcel and any Interchanges. It will also copy the file to the active Inbox directory. This completely restores the state of the Parcel to the predownloaded condition and will now appear on the ParcelInBox() and ParcelInBoxEx() calls.

Example

Visual Basic
[insert code sample]

EventID: 6023

See Also

ParcelDownload()
ParcelDownloadInner()
ParcelInBox()
ParcelInBoxEx()
MailboxInBoxTimeout()


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.