Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCPersistSink::Progress[C++]

FPCPersistSink.Progress [Visual Basic]

[C++]

The Progress method handles progress events that are raised during an export or import operation. The progress is passed as the current percentage of the total amount of data that will be exported or imported.

HRESULT Progress(
  long Percentage
);

Parameters

Percentage
[in] A 32-bit integer that represents the current percentage of the total amount of data that will be exported or imported.

Return Values

This method returns S_OK if the call is successful; otherwise, it returns an error code.

[Visual Basic]

The Progress method handles progress events that are raised during an export or import operation. The progress is passed as the current percentage of the total amount of data that will be exported or imported.

Sub Progress( _
  ByVal Percentage As Long _
)

Parameters

Percentage
[in] A 32-bit integer that represents the current percentage of the total amount of data that will be exported or imported.

Return Values

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Example Code

The following code example demonstrates how to declare an object that will receive notification of progress events raised during export or import operations, and implements the event handler. This code example must be part of Visual Basic program with a form object.

Option Explicit
Dim WithEvents arr As FPCArray
 
Private Sub arr_Progress(ByVal Percentage As Long)
  Debug.Print "Export progress: " & Percentage & "%"
End Sub

Private Sub Form_Load()
  Const serverSpecificData = 4  

  Dim root As FPCLib.FPC
  Set root = New FPC
  Set arr = root.GetContainingArray
  
  ' Export the configuration to a file with 
  ' server-specific optional data. 
  arr.ExportToFile "d:\Config.xml", serverSpecificData
End Sub

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCPersistSink