ARCreateOverlay

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

Creates an overlay for a specified object, and sets the following information:

Name of the overlay object
Type of overlaid object (active link, form, menu, and so on)
(Views and fields only) ID of the overlay object
(Views and fields only) Name of the form associated with the overlaid object
Overlay characteristics (from the inheritMask and extendMask object properties of the AROverlaidStruct parameter)

For more information about overlays, see Origin-objects-custom-objects-and-overlays.

Synopsis

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

int ARCreateOverlay(
  ARControlStruct *control
  AROverlaidStruct *overlaid
  Char objectModificationLogLabel
  ARNameType name
  ARInternalID *overlayID
  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, server, and overlayGroup fields are required.

Important

To specify the overlay group, use the AR_SESS_CONTROL_PROP_DESIGN_ OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). If that variable is set to a valid overlay group, this function creates an overlay object that belongs to that group.

overlaid

Information about the object to be overlaid, including its type (active link, form, menu, and so on).

objectModificationLogLabel

Version control label associated with an object in the object modification log. For more information, see Adding-version-control-labels-to-objects.

Return values

name

Real name of the overlay object created by this function. The name is composed of the name of the overlaid object along with the suffix __o:
overlaidObjectName__o

See Overlay-object-names.

overlayID

ID number of the overlay object if the overlaid object is a form view or a field.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. See Error-checking for a description of all possible values.