ARGetMenuFromXML

Description

Retrieves information about a menu from an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARGetMenuFromXML(
ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType menuName,
  ARNameType appBlockName,
  unsigned int *refreshCode,
  ARCharMenuStruct *menuDefn,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  ARTimestamp *modifiedDate,
  char **helpText,
  char **changeHistory,
  ARPropList *objPropList,
  unsigned int *arDocVersion,
  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, sessionId, and server fields are required.

parsedStream

The parsed XML stream.

menuName

The menu name. Each menu name must be unique.

appBlockName

For a deployable application, this is the application block name of the menu.

Return values

refreshCode

A value that indicates when the menu is refreshed. See ARCreateCharMenu for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve this value.

menuDefn

The definition of the character menu. Specify NULL for this parameter if you do not want to retrieve this value.

owner

The menu owner.

lastModifiedBy

The user who last modified the menu.

modifiedDate

The date that the menu was last modified.

helpText

The help text associated with the menu. Specify NULL for this parameter if you do not want to retrieve the help text (which is useful if you are calling this function to verify whether an instance of this object exists).

changeHistory

The change history of the menu.

objPropList

The object properties of the menu.

arDocVersion

The XML document version.

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.