cwbUN_GetAdminCacheStateEx

Purpose

This API indicates whether the next invocation of the cwbUN_GetAdminValueEx API will be long running. The cwbUN_GetAdminValueEx API caches data on the PC. If the cache is not current, the cwbUN_GetAdminValueEx API may present a sign-on prompt, or perform other processing, in order to update its cache.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetAdminCacheStateEx(
    cwbCO_SysHandle* pSysHandle,
    cwbUN_State& adminState);

Parameters

cwbCO_SysHandle* pSysHandle - input

A pointer to a system object handle. The system name must be specified in the system object prior to calling this API.

cwbUN_State& adminState

Indicates if the next invocation of the cwbUN_GetAdminValue API will be long running or if it will use its internal cache to return without accessing the host iSeries™ server.

One of three values will be returned:

cwbUN_logon

There is no current user for the specified iSeries server. The cwbUN_GetAdminValue API may present a sign-on prompt.

cwbUN_refresh

cwbUN_GetAdminValue will access the iSeries server to update its internal cache.

cwbUN_cache

cwbUN_GetAdminValue has a current cache and should not be long running.

Return Codes

The following list shows common return values:

CWB_OK

The API was successful.

Usage

This API can be used by users of cwbUN_GetAdminValueEx to determine if the next invocation of cwbUN_GetAdminValueEx will be long running.