Options Property  

Gets and sets the options used when creating an instance of the server.


object.Options [= value ]


The Options property is an integer value which specifies one or more options. The value specified for this property will be used as the default options when starting the server. The property value is created by using a bitwise operator with one or more of the following values:

Value Constant Description
1 httpServerMultiUser This option specifies the server should be started in multi-user mode, where users are assigned their own home directories and clients can access documents in those directories by including the username in the request URI. If this option is not specified, then all users will share the server root directory by default. This option does not have any effect on the maximum number of simultaneous client sessions that can be established with the server.
2 httpServerRestricted This option specifies the server should be initialized in a restricted mode, limiting certain functionality. The only commands accepted by the server will be the GET and HEAD commands. The server will never return a list of files if the client provides a URL that maps to a local directory and there is no default index page. Clients will not be able to execute CGI programs or scripts, and cannot access files outside of the server root directory or its subdirectories.
4 httpServerLocalUser This option specifies the server should perform user authentication using the Windows local account database. This option is useful if the server should accept local usernames, or if the application does not wish to implement an event handler for user authentication. If this option is not specified, the application is responsible for authenticating all users.
8 httpServerNoIndex This option specifies the server should not search for a default index page if the client provides a URL that maps to a local directory. By default, the server will search for a file named index.htm, index.html, default.htm, default.html or index.txt in the directory. If a file by one of those names is found, it will return the contents of that file rather than a list of files in the directory.
httpServerReadOnly This option specifies the server should only allow read-only access to files by default. If this option is enabled, it will change the default permissions granted to authenticated users. Commands that are used to create, delete or modify files on the server will be disabled by default. It is recommended that this option be enabled if the server is publicly accessible over the Internet.
httpServerLockFiles This option specifies that files should be exclusively locked when a client attempts to upload or download a file. If another client attempts to access the same file, the operation will fail. By default, the server will permit multiple clients to access the same file, although it will still write-lock files that are in the process of being uploaded.
httpServerHiddenFiles This option specifies that when a client requests a resource, the server should permit access to hidden and system files or subdirectories. By default, the server will not allow access to a hidden or system file, even if the client session has been authenticated. This option is ignored if the server is started in restricted mode.
httpServerSecure This option specifies that secure connections using SSL and/or TLS should be enabled. This option requires that a valid SSL certificate be installed on the local host. The default port number for secure HTTP connections is 443. If security is enabled, all client connections to the server must be secure. Standard and secure connections cannot be shared by the same instance of the server. If your application must support both standard and secure connections, you must create two instances of the server listening on two different ports, one with the httpServerSecure option enabled and the other without.
httpServerSecureFallback This option specifies the server should permit the use of less secure cipher suites for compatibility with legacy clients. If this option is specified, the server will allow connections using TLS 1.0 and cipher suites that use RC4, MD5 and SHA1.

Most of these options have a corresponding Boolean property. For example, the httpServerRestricted option corresponds to the Restricted property, where setting the property to True enables the option and setting it to False disables the option.

In most cases, it is recommended that you use the property value related to the option, rather than setting the Options property. It will make your code more readable and prevent potential compatibility issues with subsequent versions of the control. If you do decide to specify option bitflags, it is recommended that you use the constant name rather than the numeric value.

Data Type

Integer (Int32)

See Also

HiddenFiles Property, LocalUser Property, LockFiles Property, MultiUser Property, ReadOnly Property, Restricted Property, Secure Property, Start Method