Micro Focus Content Manager SDK 9.4
HP.HPTRIM.SDK.WgsProgressInfo Class Reference

Contains information about a currently executing call to the workgroup server, and also allows cancellation of the currently executing call. More...

Public Member Functions

 WgsProgressInfo ()
 

Properties

string WgsMethod [get]
 Gets the name of the workgroup server method, that the client is currently calling. More...
 
int WgsMethodElapsedMs [get]
 Gets the elapsed time of the currently executing workgroup server method. More...
 
bool IsDownloadingFile [get]
 Gets a value indicating if the client is downloading a file from the workgroup server. More...
 
bool IsUploadingFile [get]
 Gets a value indicating if the client is uploading a file from the workgroup server. More...
 
long FileTransferTotalSize [get]
 Gets the total size of the currently executing download or upload. More...
 
int FileTransferPerCentCompleted [get]
 Gets the percentage completion of the currently executing download or upload. More...
 
bool ShouldCancel [get, set]
 Gets or sets a value indicating if the current operation or file transfer should be canceled. More...
 

Detailed Description

Contains information about a currently executing call to the workgroup server, and also allows cancellation of the currently executing call.

Constructor & Destructor Documentation

HP.HPTRIM.SDK.WgsProgressInfo.WgsProgressInfo ( )

Property Documentation

int HP.HPTRIM.SDK.WgsProgressInfo.FileTransferPerCentCompleted
get

Gets the percentage completion of the currently executing download or upload.

long HP.HPTRIM.SDK.WgsProgressInfo.FileTransferTotalSize
get

Gets the total size of the currently executing download or upload.

bool HP.HPTRIM.SDK.WgsProgressInfo.IsDownloadingFile
get

Gets a value indicating if the client is downloading a file from the workgroup server.

bool HP.HPTRIM.SDK.WgsProgressInfo.IsUploadingFile
get

Gets a value indicating if the client is uploading a file from the workgroup server.

bool HP.HPTRIM.SDK.WgsProgressInfo.ShouldCancel
getset

Gets or sets a value indicating if the current operation or file transfer should be canceled.

string HP.HPTRIM.SDK.WgsProgressInfo.WgsMethod
get

Gets the name of the workgroup server method, that the client is currently calling.

int HP.HPTRIM.SDK.WgsProgressInfo.WgsMethodElapsedMs
get

Gets the elapsed time of the currently executing workgroup server method.