  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The EnumerateShares function retrieves a list of file share names from a specified host.
Syntax/Parameters
Syntax
string[] = EnumerateShares ( string host );
Parameters
host
A string containing a host name. The string is UTF-8 encoded. The host name should be in the form of a UNC, for example, “\\myhost”. It is not case-sensitive.
Return Value
Returns a string array of share names or an empty array on failure. Use the GetLastError function to retrieve error information.
The return values will be UTF-8 encoded for filenames with Unicode characters.
Remarks
Because an empty array could indicate either an error or the lack of any matching result, the GetLastError function should be used to determine if an error occurred. This function does not enumerate folder names. Use the EnumeratePlaces function to enumerate network hostnames.
Administrative shares are not enumerated.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.