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.

ARGetSupportFile

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 file supporting external reports.

Privileges

Any user who has access to the specified object.

Synopsis

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

int ARGetSupportFile(
   ARControlStruct *control,
   unsigned int  fileType,
   ARNameType name,
   ARInternalId id2,
   ARInternalId fileId,
   FILE *filePtr,
   ARTimestamp *timeStamp,
   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 associated with. 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.

fileId

The unique identifier of a file within its object.

filePtr

A pointer to a file from which the support file contents are retrieved. Specify NULL for this parameter if you do not want to retrieve the file contents. If you are using Windows, you must open the file in binary mode.

Return values

timeStamp

A time stamp that specifies the last change to the field. 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

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

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

Comments