Share Property
Selects a share.
Syntax
azurefile.getShare([callback]) azurefile.setShare( share, [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 getShare([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 setShare([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
This property selects a share, by name, for the class to operate against. It must be set before attempting most operations.
Share Name Rules
Share names must adhere to the following rules:
- Must be 3 to 63 characters long.
- Must start with a letter or number; and may only contain letters, numbers, and hyphens.
- All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to Share.)
- All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).
This property is not available at design time.
Data Type
String