esri_webfeaturelayer_branchInfo (AutoLISP)

Gets the web feature layer branch version information for the specified web feature layer as an associated list.

Syntax

(esri_webfeaturelayer_branchInfo flname branchName)

Arguments

• flname | string | required | An existing web feature layer name in the drawing.
• branchName | string | required | A branch version name associated with the flname web feature layer.

Example usage

Attempt to retrieve the branch version information for the editor01.public branch of the Distribution web feature layer.

(esri_webfeaturelayer_branchInfo "Distribution" "editor01.public")

Result example usage

Gets the branch version information for the editor01.public branch of the Distribution web feature layer as an associated list:

(("NAME" . "editor01.public") ("DESCRIPTION" . "") ("ACCESS" . "Public") ("HAS_CONFLICTS" . "False") ("IS_LOCKED" . "True") ("IS_BEING_EDITED" . "True") ("IS_BEING_READ" . "False") ("LOCK_OWNER" . "r_user"))

Return values

• If successful the function returns an associated list of web feature layer properties as dotted pairs with a label and value. The associated list of properties may contain these values and others:

  Associated label	Value type	Value description
  "NAME"	string	The name of the feature layer or subtype sublayer.
  "DESCRIPTION"	string	Information provided by the creator of the branch version.
  "ACCESS"	string	The access level of the branch version . Options include: {"Public", "Private", "Protected""}
  "HASCONFLICTS"	string	Indicates whether or not the branch has a state of edit conflicts: {"True", "False"}
  "IS_LOCKED"	string	Indicates whether or not the branch version state is locked : {"True", "False"}
  "IS_BEING_EDITED"	string	Indicates whether or not the features of the branch are being edited : {"True", "False"}
  "IS_BEING_READ"	string	Indicates whether or not the features of the branch are being read : {"True", "False"}
  "LOCK_OWNER"	string	The name of the user with a branch version lock on the web feature layer.

• If failed, returns a list with the first value of nil and then an associated list containing the key value "Error" and an associated error message as a string: (nil ( "Error" . "<message>"))

Failed return values

A failed return value can occur for any of the following reasons:

• (nil ("Error" . "Missing required argument."))

  The required argument is not supplied.

• (nil ("Error" . "Service error encountered"))

  Returned if there is any issue connecting to the web service.

• (nil ("Error" . "One or more errors occurred."))

  Returned if there is an unforseen issue when reading the information.

• (nil ("Error" . "Layer does not support branch versions")

  Layer does not support branch versions.

• (nil ("Error" . "Unable to retrieve properties from the branch version")

  Invalid values or some other connection error.