ARSetSupportFile

Important

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

Sets a support file in the AR System.

If you perform a set operation on an overlay and you provide values for an inherited grain, the values are ignored. Only values for extended or overwritten grains of the overlay are set.

Synopsis

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

int ARSetSupportFile (
  ARControlStruct *control,
  unsigned int fileType,
  ARNameType name,
  ARInternalId id2,
  ARInternalId fileId,
  FILE *filePtr,
  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 associated identifier if the object identifier is not enough.

fileId

The unique identifier of a file within its object.

filePtr

A pointer to the support file to be set in the system. If you are 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.