ARGetMultipleEntryPoints

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 entry points of multiple applications. It returns the entry points that are accessible by the user, taking into account user permissions, licenses, and application states.

Privileges

The system returns information based on the access privileges of the user that you specify for the control parameter.

Synopsis

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

int ARGetMultipleEntryPoints(
   ARControlStruct *control,
   ARTimeStamp changedSince,
   ARNameList *appNameList,
   ARReferenceTypeList *refTypeList,
   ARNameType *displayTag,
   unsigned int *vuiType,
   ARNameList *entryPointNameList,
   ARUnsignedIntList *entryPointTypeList,
   ARTextStringList *entryPointDLabelList,
   ARNameList *ownerAppNameList,
   ARTextStringList *ownerAppDLabelList
   ARPermissionListList *groupListList,
   ARContainerOwnerObjListList *ownerObjListList,
   ARTextStringList *descriptionList,
   ARReferenceListList *referencesList,
   ARTextStringList *helpTextList,
   ARTimestampList *timestampList,
   ARPropListList *objPropListList,
   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.

changedSince

A time stamp that limits the objects retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve objects with any modification time stamp.

appNameList

A list of applications objects that contains the entry points.

refTypeList

A list of reference types to be retrieved.

displayTag

The name of the form view (VUI) to use for the entry point label. If the specified view does not exist or you specify NULL for this parameter, the system uses the default view.

vuiType

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

`0:`	No VUI type (`AR_VUI_TYPE_NONE`).
`1:`	Windows type (`AR_VUI_TYPE_WINDOWS`)* — fields in BMC Remedy User.
`2:`	Web relative type (`AR_VUI_TYPE_WEB`) — fields in view can be adjusted.
`3:`	Web absolute type (`AR_VUI_TYPE_WEB_ABS_POS`) — fields in view are fixed.

Fields marked with a * are available for legacy environments that use BMC Remedy User, which is no longer shipped with BMC Remedy AR System.

Return values

entryPointNameList

A list of entry point names. If the entry point type is an active link guide, this is the name of the container. If the entry point type is a form, this is the name of the form.

entryPointTypeList

A list of entry point types.

`1:`	The entry point type for an active link guide (`AR_ENTRYPOINT_TYPE_AL_GUIDE`).
`2:`	The entry point type for a form in default search mode (`AR_ENTRYPOINT_TYPE_DEFAULT_SEARCH`).
`3:`	The entry point type for a form in default new entry mode (`AR_ENTRYPOINT_TYPE_DEFAULT_NEW`).

entryPointDLabelList

Display label for entry point, which is optionally localized.

ownerAppNameList

The application owner of the entry point.

ownerAppDLabelList

The display label for the application owner, which is optionally localized. This is the localized label for the application container object.

groupListList

A list of zero or more groups who can access this form or active link guide. Access to this information is limited to users with BMC Remedy AR System administrator privileges. Specify NULL for this parameter if you do not want to retrieve the group list.

ownerObjListList

For active link guide entry points, a list of the schemas that own this container. For form entry points, this is the name of the form that the default entry point came from. Specify NULL for this parameter if you do not want to retrieve this value. If this parameter returns NULL, the container exists globally.

descriptionList

For active link guide entry points, this is the list of descriptions for this entry point. Specify NULL for this parameter if you do not want to retrieve the list.

referencesList

A list of pointers to the objects (for example, forms or filters) referenced by this container. Specify NULL for this parameter if you do not want to retrieve this value.

helpTextList

A list of the help texts associated with the entry point. Specify NULL for this parameter if you do not want to retrieve the help texts (which is useful if you are calling this function to verify whether instances of these objects exist).

timestampList

A list of time stamps that specify the last change to the entry point object. Specify NULL for this argument if you do not want to retrieve this value.

objPropListList

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

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.