ARSetVUI

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

Updates the form view (VUI) with the indicated ID on the specified server.

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.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARSetVUI(
  ARControlStruct *control,
  ARNameType schema,
  ARInternalId vuiId,
  ARNameType vuiName,
  ARLocaleType locale,
  unsigned int *vuiType,
  ARPropList **objPropList*, 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.

If a valid overlay group is specified in the control record, the ARSet* function operates on the object that belongs to that group. If no group is specified, the function operates on the origin object. To specify whether to use an object's real or resolved name in an operation and whether to perform the operation only on objects in a specified overlay group, use the AR_SESS_CONTROL_PROP_DESIGN_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration).

schema

The name of the form containing the VUI to update.

vuiId

The internal ID of the VUI to update.

vuiName

The new name for the VUI. The names of all VUIs and fields associated with a given form must be unique. Specify NULL for this parameter if you do not want to change the name of the VUI.

locale

The locale of the VUI. Specify NULL for this parameter if you do not want to change the name of the VUI.

vuiType

The type of VUI. Specify NULL for this parameter if you do not want to retrieve the VUI type.The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Field marked with an asterisk (*) is available for legacy environments that use BMC Remedy User, which is no longer shipped with BMC Remedy AR System.

dPropList

A list of zero or more display properties to associate with the VUI. See ARCreateVUI for a description of the possible values. Specify 0 (AR_DPROP_NONE) to assign no display properties. Specify NULL for this parameter if you do not want to change this list.

helpText

The help text associated with the VUI. This text can be of any length. Specify NULL for this parameter if you do not want to change the help text.

owner

The owning user for the VUI. Specify NULL for this parameter if you do not want to change the owner.

changeDiary

The additional change diary text to associate with the VUI. This text can be of any length and is appended at the end of any existing text. Existing change diary text cannot be deleted or changed. The server adds the user making the change and a time stamp when it saves the change diary. Specify NULL for this parameter if you do not want to associate change diary text with this object.

objPropList

A list of server object properties. If this parameter is set to NULL, no new properties are set. See Server object properties.

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.