ARGetContainer
Privileges
This operation can be performed by users with access permission for the container. Access to groupList and admingrpList information is limited to users with AR System administrator privileges.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARGetContainer(
ARControlStruct *control,
ARNameType name,
ARReferenceTypeList *refTypes,
ARPermissionList *assignedGroupList
ARPermissionList *groupList,
ARInternalIdList *admingrpList,
ARContainerOwnerObjList *ownerObjList,
char **label,
char **description,
unsigned int *type,
ARReferenceList *references,
char **helpText,
ARAccessNameType owner,
ARTimestamp *timestamp,
ARAccessNameType lastChanged,
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 Configuration-settings-N-R.
name
The name of the container to be retrieved.
refTypes
A list of the types of references (for example, forms and filters) to be retrieved. You can specify individual types of references, all (ARREF_ALL) or none (ARREF_NONE) of the references be retrieved. You can also specify negative numbers to treat the types of references as excluded reference types. The excluded reference types take precedence over the included list; this means that if you specify a type as positive as well as negative, then all references of negative type are excluded.
Return values
assignedGroupList
A list of zero or more groups that are directly assigned permission to access the container.
groupList
A list of zero or more groups who can access this container, including the inheritance hierarchy in the case of hierarchical groups. Access to this information is limited to users with AR System administrator privileges.
Specify NULL for this parameter if you do not want to retrieve this value.
If the static inheritance property is not enabled for the container, this list will be the same as the assignedGroupList.
admingrpList
A list of zero or more groups who can administer this container (and the referenced objects). If ownerObj does not return NULL, this list is the Subadministrator group list of the owning form. Users must belong to both a specified group and the Subadministrator group to obtain these privileges.
Specify NULL for this parameter if you do not want to retrieve this value.
ownerObjList
A list of the schemas that own this container.
Specify NULL for this parameter if you do not want to retrieve this value. If this parameter returns NULL, the container exists globally.
label
The label for this container. Specify NULL for this parameter if you do not want to retrieve this value.
description
The description for this container.
Specify NULL for this parameter if you do not want to retrieve this value.
type
The type for this container.
Specify NULL for this parameter if you do not want to retrieve this value.
references
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.
helpText
The help text associated with the container.
Specify NULL for this parameter if you do not want to retrieve the help text. 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.
owner
The owning user for the container.
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 container.
Specify NULL for this parameter if you do not want to retrieve this value.
lastChanged
The user who made the last change to the container.
Specify NULL for this parameter if you do not want to retrieve this value.
changeDiary
The change diary associated with the container. 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 it an object exists.
objPropList
A list of server object properties. If this parameter is set to NULL, a properties list with zero properties is associated with the object. 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.