This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARValidateFormCache

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves key information from a cached definition (such as form name, form change time, active link change time, active link guide change time, and menu change time) and returns information about any changes to the definition given this information. This function also returns information about updates to the current user performing a test. This information causes the cache to reload to insure accurate definitions.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARValidateFormCache(
   ARControlStruct *control,
   ARNameType form,
   ARTimestamp mostRecentActLink,
   ARTimestamp mostRecentMenu,
   ARTimestamp mostRecentGuide,
   ARTimestamp *formLastModified,
   int *numActLinkOnForm,
   int *numActLinkSince,
   ARNameList *menuSinceList,
   ARTimestamp *groupsLastChanged,
   ARTimestamp *userLastChanged,
   ARNameList *guideSinceList,
   ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

form

The name of the form to validate changes in.

A time stamp that you provide for the most recent modification time that you know about of an active link for the form.

mostRecentMenu

A user supplied time stamp that provides the most recent modification time for the form menu.

mostRecentGuide

A user supplied time stamp that provides the most recent modification time for an active link guide for the form.

Return values

formLastModified

A time stamp that identifies the last modification time of the form. Specify NULL for this parameter if you do not want to retrieve this value.

numActLinkOnForm

An integer that indicates the number of active links associated with the form that are accessible by the current user. Specify NULL for this parameter if you do not want to retrieve this value.

numActLinkSince

An integer that indicates the number of active links associated with the form that are accessible to the current user and that have been modified since the time indicated by mostRecentActLink. Specify NULL for this parameter if you do not want to retrieve this value.

menuSinceList

A list of menus changed since the time specified in mostRecentMenu. Specify NULL for this parameter if you do not want to retrieve this value.

groupsLastChanged

A time stamp that specifies the last change made to any Group on the server. Specify NULL for this parameter if you do not want to retrieve this value.

userLastChanged

A time stamp that specifies the last change made to the current user. Specify NULL for this parameter if you do not want to retrieve this value.

guideSinceList

A list of active link guides changed since the time specified in the mostRecentGuide argument. Specify NULL for this parameter if you do not want to retrieve this value.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error checking.

See also

ARGetListActiveLink, ARGetListCharMenu, ARGetListContainer, ARGetSchema, ARGetServerInfo. See FreeAR for: FreeARStatusList.

Was this page helpful? Yes No Submitting... Thank you

Comments