FtsRevokeStatusCallback Method

Revokes a registered transfer progress notification request callback.

Syntax

NSFile.FtsRevokeStatusCallback( Cur, Per, Data, Tot, Pack, Drop, Corr, Bogus, Dup, Flags )

Parameters

Cur

The number of file data bytes that are transferred before each notification occurs. This does not include file header bytes or other non-data file information, such as redundancy bytes. For example, specifying 8192 revokes an FtsOnTransferProgress notification for every 8 KB of file data bytes that are transferred.

Per

The percent of file data bytes that are transferred before each notification occurs. This does not include file header bytes or other non-data file information. such as redundancy bytes. For example, specifying 10 revokes an FtsOnTransferProgress notification for every 10 percent of the file data bytes transferred.

Data

The total data bytes (for all files requested) that are transferred before each notification occurs. This does not include file header bytes or other non-data file information. such as redundancy bytes. For example, specifying 8192 revokes an FtsOnTransferProgress notification for every 8 KB of file data bytes transferred, even if this included more than one file.

Tot

Total bytes (for all files requested) that are transferred before each notification occurs, including file header bytes or other non-data file information, such as redundancy bytes. For example, specifying 8192 revokes an FtsOnTransferProgress notification for every 8 KB of file bytes transferred, even if this included more than one file.

Pack

Number of packets that are transferred before each notification occurs. For example, specifying 100 revokes an FtsOnTransferProgress notification for every 100 packets transferred.

Drop

Number of packets that are dropped before each notification occurs. For example, specifying 50 revokes an FtsOnTransferProgress notification for every 50 packets dropped.

Corr

Number of packets that are corrected before each notification occurs. For example, specifying 25 revokes an FtsOnTransferProgress notification for every 25 packets received and corrected.

Bogus

Number of bogus packets that are received before each notification occurs. For example, specifying 25 revokes an FtsOnTransferProgress notification for every 25 bogus packets received. A bogus packet is a packet that is received on the same IP address and port as the receiver is listening for, but is not part of an expected file transfer operation. For example, this happens if, while a file transfer is taking place, the receiving address starts getting audio packets on the same address.

Dup

Number of duplicate packets that are received before each notification occurs. For example, specifying 5 revokes an FtsOnTransferProgress notification for every five duplicate packets received.

Flags

The following flags are used by this method to define the type of notification request you want to revoke. Multiple flags can be used on each revoke request. If 0 (zero) is specified, the File Transfer object defaults to a “Transfer completed” notification (the same value as 8).

Return Values

This method does not return a value. However, this object does return a Microsoft COM HRESULT error code to the Error object inVBScript.

The following codes are passed to the Error object.