ClientPropertyName Property
The table property's name.
Syntax
amqpclassic.getClientPropertyName(index, [callback]) amqpclassic.setClientPropertyName(index, clientPropertyName, [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 getClientPropertyName([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 setClientPropertyName([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 table field's name.
This property specifies the table field's name. The name must be an ASCII string that:
- Starts with an ASCII letter, $, or $ character.
- Only contains ASCII letters, digits, underscores, $, and $ characters.
- Is unique among all sibling table field ClientPropertyNames.
- Is no longer than 128 characters.
The index parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.
This property is not available at design time.
Data Type
String