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.

ARGetListSupportFile

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 a list of support file IDs for a specified type of object.

Privileges

Any user who has access to the specified object.

Synopsis

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

int ARGetListSupportFile(
   ARControlStruct *control,
   unsigned int fileType,
   ARNameType name,
   ARInternalId id2,
   ARTimestamp changedSince,
   ARInternalIdList *fileIdList,
   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.

fileType

The numerical value for the type of file, and the type of object the file is related to. Specify 1 (AR_SUPPORT_FILE_EXTERNAL_REPORT) for an external report file associated with an active link.

name

The name of the object the file is associated with, usually a form.

id2

The ID of the field or VUI, if the object is a form. If the object is not a form, set this parameter to 0.

changedSince

A time stamp that limits the IDs retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve all IDs.

Return values

fileIdList

A list of support file IDs linked to an object.

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

ARCreateAlertEvent, ARCreateSupportFile, ARDeleteActiveLink, ARDeleteSupportFile, ARGetActiveLink, ARGetSupportFile, ARSetActiveLink, ARSetSupportFile.

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

Comments