ARGetImage

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

Retrieves information about the specified image from the specified server.

Related topics

ARCreateImage

ARDeleteImage

ARGetListImage

ARGetMultipleImages

ARSetImage

FreeAR

Privileges

AR System administrator.

Synopsis

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

int ARGetImage(
  ARControlStruct *control,
  ARNameType name,
*ARImageDataStruct*
*content,
  char *imageType,
  ARTimeStamp *timestamp,
  char **checkSum,
  char **description,
  char **helpText,
  ARAccessNameType owner,
  char **changeDiary,
  ARPropList *objPropList,
  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.

To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.

If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode in ar-cfg-or-ar-conf-options-N-R.

name

The name of the image to be retrieved.

Return values

content

The data for the image. See Images-and-data-structures.

Specify NULL for this parameter if you do not want to retrieve this value.

imageType

The image encoding type stored as a character string. Valid values are: BMP, GIF, JPEG or JPG, and PNG.

Specify NULL for this parameter if you do not want to retrieve this value.

timestamp

A time stamp that specifies the last change to the image.

Specify NULL for this parameter if you do not want to retrieve this value.

checkSum

The MD5 hash value retrieved from the database for the image data in content. Your program can compute an MD5 hash value and check it against this value to check whether the image data was retrieved correctly.

description

The description for this image. It can be as many as 2000 characters long or NULL.

Specify NULL for this parameter if you do not want to retrieve this value.

helpText

The help text associated with the image. This text can be of any length.

Specify NULL for this parameter if you do not want to retrieve this value.

owner

The owner for the image.

Specify NULL for this parameter if you do not want to retrieve this value.

changeDiary

The change diary associated with the image. The server adds the user making the change and a time stamp when it saves the change diary.

Use ARDecodeDiary to parse the change diary into user, time stamp, and text components.

Specify NULL for this parameter if you do not want to retrieve the change diary. This value can be large, so do not retrieve it if the program does not need it; for example, if the program is only checking if an object exists.

objPropList

A list of server object properties. If this parameter is set to NULL, no properties are returned. See Server-object-properties-and-structures.

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.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*