ARGetEntryBLOB

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 the attachment, or binary large object (BLOB), stored for the attachment field with the indicated ID from the specified server. The BLOB can be placed in a buffer or a file.

Privileges

The system returns data based on the access privileges of the user that you specify for the control parameter. User permissions are verified for the specified field. If the user cannot access the field, the system returns an error message.

Synopsis

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

int ARGetEntryBLOB(
  ARControlStruct *control,
  ARNameType schema,
  AREntryIdList *entryId,
  ARInternalId id,
  ARLocStruct *loc,
  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.

schema

The name of the form containing the entry to retrieve.

entryId

The ID of the entry to retrieve.

Note

The system identifies entries in join forms by concatenating the entry IDs from the member forms. As a result, an entry ID can consist of one or more values of type AREntryIdType and, therefore, is represented by the AREntryIdList structure.

id

The ID that specifies the field to retrieve.

loc

A pointer to an ARLocStruct structure that specifies how you want the contents of the blob returned: in a file (AR_LOC_FILENAME) or a data buffer (AR_LOC_BUFFER). The structure also contains the name of the file or buffer to be used.

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.