write

  • Article

This function writes the specified string to the specified file. If the specified file does not yet exist, it is created.

Syntax

function xweb.file.write(
path : String, 
contents : String, 
mode : String
) : boolean

Parameters

path    The location of the file, which must be within the site. Must be prefixed by site:.

contents    The string to be written to the specified file.

mode    Optional. The only value for the mode parameter is append, which adds the contents string to the end of the specified file. If the mode parameter is not specified, the contents of the specified file are overwritten.

Returns

true    The contents string was successfully written to the file.

false    The write was not successful.

See Also

Concepts

file
file Members
xweb

  Copyright © 2011 by Microsoft Corporation. All rights reserved.