Creates a web feature layer branch version for the specified web feature layer.
Syntax
(esri_webfeaturelayer_createBranch flname branchInfo)
Arguments
The following arguments are included as follows:
- flname | string | required | An existing web feature layer name in the drawing.
- branchName | string | required | A name to be used for the new branch version.
- branchInfo | Associated list | required | Branch version information to be applied to the flname web feature layer as an associated list of dotted pairs as described below:
| Associated label | Value type | Value description |
|---|---|---|
| "DESCRIPTION" | string | (Optional) Description text provided by the creator of the branch version. (64 characters) |
| "ACCESS" | string | The access level of the branch version. Options include: {"Public", "Private", "Protected"} |
Example usage
Attempt to create a new branch version called SouthwestProposal for the Damage_to_Commercial_Buildings web feature layer.(esri_webfeaturelayer_createBranch "Damage_to_Commercial_Buildings" "SouthwestProposal"
(list
(cons "DESCRIPTION" "proposed changes")
(cons "ACCESS" "Public")
)
)
Result example usage
Creates a new branch version called SouthwestProposal for the Damage_to_Commercial_Buildings web feature layer and returns :
("SouthwestProposal")Return values
- If successful the function returns a list containing the branch version name as a string.
- 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" . "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.