FtsRevokeStatusCallback Method

Revokes a registered transfer progress notification request callback. To revoke a specific status callback, you must match the pattern of parameters that was used to request the callback. For example, if a call was made with FtsRegisterStatusCallback(0,10,0,0,0,0,0,0,100,0,0), which would request a notification for every 10 percent of the data bytes of the file transfer as well as for every 100 duplicate packets received, that particular notification can be revoked only by the matching call: FtsRevokeStatusCallback(0,10,0,0,0,0,0,0,100,0). Note that FtsRegisterStatusCallback has 11 parameters and FtsRevokeStatusCallback has only 10. The revoke does not use the Param parameter.

Syntax

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

Parameters

Cur

Number of file data bytes that will transfer before each notification occurs. Does not include file header bytes or other non-data file information such as redundancy bytes. For example, specifying 8192 would revoke an FtsOnTransferProgress notification for every 8K of file data bytes transferred.

Per

Percent of file data bytes that will transfer before each notification occurs. Does not include file header bytes or other non-data file information such as redundancy bytes. For example, specifying 10 would revoke an FtsOnTransferProgress notification for every 10 percent of the file data bytes transferred.

Data

Total data bytes (for all files requested) that will transfer before each notification occurs. Does not include file header bytes or other non-data file information such as redundancy bytes. For example, specifying 8192 would revoke an FtsOnTransferProgress notification for every 8K of file data bytes transferred, even if this included more than one file.

Tot

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

Pack

Number of packets that will transfer before each notification occurs. For example, specifying 100 would revoke an FtsOnTransferProgress notification for every 100 packets transferred.

Drop

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

Corr

Number of packets that are corrected before each notification occurs. For example, specifying 25 would revoke 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 would revoke 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 would happen if a file transfer were taking place and the receiving address started getting audio packets on the same address.

Dup

Number of duplicate packets that are received before each notification occurs. For example, specifying 5 would revoke 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 would default 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 Visual Basic Script Error object.

The following codes are passed to the Error object: