Generic server callback method.
Get a list of items that currently need beeing refresh, from the generic server.
A refresh is needed when:
- the timestamp is older then the maxAge argument
- Professional version only:
- the item is used by at least on client and the timestamp is older then the item defined maxAge. The item maxAge is the client defined sampling rate, if defined, otherwise the plug-in defined sampling rate is used. If this is undefined also then the maxAge argument is used.
Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Shared Sub GetRefreshNeed( _ ByVal mode As Integer, _ ByVal maxAge As Integer, _ ByRef hnd As Integer() _ ) | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim mode As Integer Dim maxAge As Integer Dim hnd As Integer() GenericServer.GetRefreshNeed(mode, maxAge, hnd) | |
| Managed Extensions for C++ | |
|---|---|
public: static void GetRefreshNeed( int mode, int maxAge, [PARAMFLAG::Out] int[] hnd ) | |
Parameters
- mode
Controls how the generic server Professional Edition determines if the item needs refresh.
0: return all items with exeeded maxAge
1: return only items with activeCount>0 and exceeded maxAge- maxAge
- MaxAge time in ms.
- hnd
- Array of handles of the items that need to be refreshed.
Return Value
Always returns S_OKRequirements
Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family