Micro Focus Content Manager SDK 10.1
TRIM.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

◆ WgsProgressInfo()

TRIM.SDK.WgsProgressInfo.WgsProgressInfo ( )

Property Documentation

◆ FileTransferPerCentCompleted

int TRIM.SDK.WgsProgressInfo.FileTransferPerCentCompleted
get

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

◆ FileTransferTotalSize

long TRIM.SDK.WgsProgressInfo.FileTransferTotalSize
get

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

◆ IsDownloadingFile

bool TRIM.SDK.WgsProgressInfo.IsDownloadingFile
get

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

◆ IsUploadingFile

bool TRIM.SDK.WgsProgressInfo.IsUploadingFile
get

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

◆ ShouldCancel

bool TRIM.SDK.WgsProgressInfo.ShouldCancel
getset

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

◆ WgsMethod

string TRIM.SDK.WgsProgressInfo.WgsMethod
get

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

◆ WgsMethodElapsedMs

int TRIM.SDK.WgsProgressInfo.WgsMethodElapsedMs
get

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