GroupNewName Property

The new name of the group.

Syntax

 spadmin.getGroupNewName(index, [callback])
 spadmin.setGroupNewName(index,  groupNewName, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getGroupNewName([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setGroupNewName([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The new name of the group.

Use this GroupField to rename the group when UpdateGroups is called.

The size of the array is controlled by the GroupCount property.

This property is not available at design time.

Data Type

String