ARDBCGetEntryBLOB

Description

This function opens an attachment. When a AR System client calls the ARGetEntryBLOB API function to open an attachment from an external form, the AR System server sends a request and the plug-in server calls the ARDBCGetEntryBLOB function.

Important

If you do not define this function and the plug-in server receives a get entry BLOB request, the AR System server receives an error message and does not retrieve the data.

Synopsis

#include "ardbc.h"

int ARDBCGetEntryBLOB(
  void *object,
  char *tableName,
  ARVendorFieldList *vendorFieldList,
  ARInternalId transId,
  AREntryIdList *entryId,
  ARInternalId fieldId
  ARLocStruct *loc
  ARStatusList *status)

Input arguments

object

Pointer to the plug-in instance that the call to ARPluginCreateInstance returned.

tableName

Name of the external table that contains the attachment to open.

vendorFieldList

List of external form fields. The plug-in uses this list to map AR System field identification numbers (field IDs) to corresponding external form field names. All other input arguments and return values must see the AR System field IDs.

transId

Transaction identification number (transaction ID) that the plug-in server designates for each transaction. The transaction ID is unique to the thread that the AR System server uses to access the ARDBC plug-in. There is only one open transaction per server thread.

entryId

The unique identifier for the entry that this function retrieves. This must correspond to a value in the external data source and must be unique, non-NULL, and either character or numeric data. For an external data source, the entry ID can have more than 15 characters. Therefore, the entry ID can consist of one or more values of type AREntryIdType and is represented by the AREntryIdList structure.

fieldId

Field ID for the field that this function retrieves.

Return values

loc

Pointer to an ARLocStruct structure that contains the name of the buffer.

status

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.