ARCreateSupportFile

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

Creates a file that clients can retrieve by using the BMC Remedy AR System. Such files are commonly used for reports (to store them separately from the active link that calls them, preventing large downloads of unneeded information), but this function can store any file on the server. Each support file is associated with a server object.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARCreateSupportFile(
   ARControlStruct *control,
   unsigned int fileType,
   ARNameType name,
   ARInternalId id2,
   ARInternalId fileId,
   FILE *filePtr,
   ARStatusList *status)

Input arguments

control

The control record for the operations. It contains information about the user requesting the operation, where the 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.

fileId

The unique identifier of a file within its object.

filePtr

A pointer to the support file to be created in the system. If using Windows, you must open the file in binary mode.

Return values

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.