Dota 2 Workshop Tools/Scripting/API/Global.StringToFile: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Brief description of parameters, added Notes to explain some of the functions behaviour)
(Dota_Lebot push: Updated Page)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Note | This page is automatically generated.  Any changes may be overwritten}}
{{Note | This page is automatically generated.  Any changes may be overwritten}}
[[Category:Dota2Function]]
[[Category:Global]]


== Function Description ==
== Function Description ==


''' bool StringToFile(string ''a'', string ''b'') '''
''' bool StringToFile(string ''a'', string ''b'') '''


''Store a ''string'' to a file for later reading''
''* Directory traversal doesn't seem to work. The characters '.', '/' and '\\' are ignored.
* The file name cannot be blank, nor can it consist only of the ignored characters, else the function will do nothing and return false.
* Only one string can be stored at a time, the file is overwritten to at every call.
* The file ends with a NUL character.
* The files are stored at C:\Program Files (x86)\Steam\steamapps\common\dota 2 beta\dota_ugc\game\dota\ems
* The function is used in conjunction with [[Dota_2_Workshop_Tools/Scripting/API/Global.FileToString|FileToString]]''
 
 


== Parameters ==
== Parameters ==
Line 15: Line 25:
| string
| string
| a
| a
| The file name.
| No Description Set
|-
|-
| string
| string
| b
| b
| The string to store in the file.
| No Description Set
|}
|}


== Returns ==
== Returns ==


''bool'' - Whether or not the function was successful in storing the string in the file.
''bool'' - No Description Set
 
== Notes ==
 
* Directory traversal doesn't seem to work. The characters '.', '/' and '\\' are ignored.
* The file name cannot be blank, nor can it consist only of the ignored characters, else the function will do nothing and return false.
* Only one string can be stored at a time, the file is overwritten to at every call.
* The file ends with a NUL character.
* The files are stored at C:\Program Files (x86)\Steam\steamapps\common\dota 2 beta\dota_ugc\game\dota\ems
* The function is used in conjunction with [[Dota_2_Workshop_Tools/Scripting/API/Global.FileToString|FileToString]]

Latest revision as of 02:13, 17 June 2015

Note.pngNote: This page is automatically generated. Any changes may be overwritten

Function Description

bool StringToFile(string a, string b)

* Directory traversal doesn't seem to work. The characters '.', '/' and '\\' are ignored.

  • The file name cannot be blank, nor can it consist only of the ignored characters, else the function will do nothing and return false.
  • Only one string can be stored at a time, the file is overwritten to at every call.
  • The file ends with a NUL character.
  • The files are stored at C:\Program Files (x86)\Steam\steamapps\common\dota 2 beta\dota_ugc\game\dota\ems
  • The function is used in conjunction with FileToString


Parameters

Type Name Description
string a No Description Set
string b No Description Set

Returns

bool - No Description Set

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Dota_2_Workshop_Tools/Scripting/API/Global.StringToFile&oldid=190723"