IFPCConnectivityVerifiers::RefreshRate property

Applies to: desktop apps only

The RefreshRate property gets or sets the time, in seconds, that the connectivity verifiers wait before rechecking connectivity.

This property is read/write.

Syntax

HRESULT put_RefreshRate(
  long lRefreshRate
);

HRESULT get_RefreshRate(
  long *plRefreshRate
);

' Data type: Long

Property RefreshRate( _
  ByVal lRefreshRate As long, _
  ByVal plRefreshRate As long _
) As Long

Property value

A 32-bit integer that specifies the time, in seconds, that the connectivity verifiers wait before rechecking connectivity.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. It is initially set to 30, and its range of permissible values is from 15 through 1,440.

This property cannot be accessed through Forefront TMG Management.

Examples

This VBScript subprocedure changes the value of the RefreshRate property to the new value provided if necessary. This example does not include error handling.

Sub SetConnectivityRefreshRate(newValue)
    'Declare the objects needed.
    Dim root       ' The FPCLib.FPC root object
    Dim isaArray   ' An FPCArray object
    Dim verifiers  ' An FPCConnectivityVerifiers collection
    ' Create the root object.
    Set root = CreateObject("FPC.Root")
    ' Get references to the array object
    ' and the connectivity verifiers collection.
    Set isaArray = root.GetContainingArray()
    Set verifiers = isaArray.ConnectivityVerifiers
    ' Change the value of the property if necessary.
    WScript.Echo "Current refresh time: " & verifiers.RefreshRate
    If newValue <> verifiers.RefreshRate Then
        WScript.Echo "Setting the refresh time to " & newValue & "..."
        verifiers.RefreshRate = newValue
        verifiers.Save
        WScript.Echo "Done!"
    End If
End Sub

Requirements

See also

FPCConnectivityVerifiers

Build date: 7/12/2010