ARExpandCharMenu
Description
Expands the references for the specified menu definition and returns a character menu with only list-type items.
Privileges
The system returns information based on the access privileges of the user that you specify for the control parameter. All query items, therefore, are limited to fields the user can access.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARExpandCharMenu(
ARControlStruct *control, /* IN/OUT; control information for access */
ARCharMenuStruct *menuIn, /* IN; definition of the menu structure */
unsigned int maxRetrieve, /* IN; max entries to retrieve for query */
ARCharMenuStruct *menuOut, /* OUT; expanded menu definition */
unsigned int *numMatches, /* OUT; number of matches for qualifier; */
ARStatusList *status /* OUT; result status of the operation */
)
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.
menuIn
The menu definition to expand.
maxRetrieve
The maximum number of entries to retrieve for the Search menu. Use this parameter to limit the amount of data returned if the menu qualification does not sufficiently narrow the list. Specify 0 (AR_NO_MAX_LIST_RETRIEVE) to assign no maximum.
Return values
menuOut
The expanded character menu. The menu definition contains only list-type items.
numMatches
The total number of (accessible) entries that match the menu qualification criteria. This value does not represent the number of entries returned unless the number of matching entries is less than or equal to the maxRetrieve value. Specify NULL for this parameter if you do not want to retrieve this value.
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.
See also
ARCreateCharMenu, ARDeleteCharMenu, ARGetCharMenu, ARGetListCharMenu, ARSetCharMenu. See FreeAR for: FreeARCharMenuStruct, FreeARStatusList.
Description
Expands the references for the specified menu definition and returns a character menu with only list-type items.
Privileges
The system returns information based on the access privileges of the user that you specify for the control parameter. All query items, therefore, are limited to fields the user can access.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARExpandCharMenu(
ARControlStruct *control, /* IN/OUT; control information for access */
ARCharMenuStruct *menuIn, /* IN; definition of the menu structure */
unsigned int maxRetrieve, /* IN; max entries to retrieve for query */
ARCharMenuStruct *menuOut, /* OUT; expanded menu definition */
unsigned int *numMatches, /* OUT; number of matches for qualifier; */
ARStatusList *status /* OUT; result status of the operation */
)
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.
menuIn
The menu definition to expand.
maxRetrieve
The maximum number of entries to retrieve for the Search menu. Use this parameter to limit the amount of data returned if the menu qualification does not sufficiently narrow the list. Specify 0 (AR_NO_MAX_LIST_RETRIEVE) to assign no maximum.
Return values
menuOut
The expanded character menu. The menu definition contains only list-type items.
numMatches
The total number of (accessible) entries that match the menu qualification criteria. This value does not represent the number of entries returned unless the number of matching entries is less than or equal to the maxRetrieve value. Specify NULL for this parameter if you do not want to retrieve this value.
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.
See also
ARCreateCharMenu, ARDeleteCharMenu, ARGetCharMenu, ARGetListCharMenu, ARSetCharMenu. See FreeAR for: FreeARCharMenuStruct, FreeARStatusList.