Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

EnumerateShares Function

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