Programmer Guide/Shell Items/File/NEW FILE - Revision history

Jw: adding file template

2015-05-05T06:00:31Z

adding file template

← Older revision		Revision as of 08:00, 5 May 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{File Item}}
	The command <code>NEW FILE</code> creates a new file item. File items are used to read and write files to disk. There are special <code>[[Programmer_Guide/Shell_Items/File/SET_FILE\|SET]]</code> commands to deal with different types of files (e.g. XML files or files using the ''section'' format). The availability of these commands is dependant on the <code>NEW FILE</code> command variant which was used to create the item (see below).		The command <code>NEW FILE</code> creates a new file item. File items are used to read and write files to disk. There are special <code>[[Programmer_Guide/Shell_Items/File/SET_FILE\|SET]]</code> commands to deal with different types of files (e.g. XML files or files using the ''section'' format). The availability of these commands is dependant on the <code>NEW FILE</code> command variant which was used to create the item (see below).

2012-12-05T12:15:05Z

← Older revision		Revision as of 14:15, 5 December 2012
Line 26:		Line 26:
	NEW FILE <var>name</var> /File [ /G ]		NEW FILE <var>name</var> /File [ /G ]

	Create a file item that can be used for file-system functions ([[Programmer_Guide/Shell_Items/File/SET_FILE#STATUS\|<code>STATUS</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#RENAME_and_COPY\|<code>RENAME</code>]] (=move), [[Programmer_Guide/Shell_Items/File/SET_FILE#~~RENAME_and_COPY~~\|<code>COPY</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#DELETE\|<code>DELETE</code>)]], but cannot access the content of a file.		Create a file item that can be used for file-system functions ([[Programmer_Guide/Shell_Items/File/SET_FILE#STATUS\|<code>STATUS</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#RENAME_and_COPY\|<code>RENAME</code>]] (=move), [[Programmer_Guide/Shell_Items/File/SET_FILE#COPY\|<code>COPY</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#DELETE\|<code>DELETE</code>)]], but cannot access the content of a file.
	{\|		{\|
	\| <var>name</var>		\| <var>name</var>

2012-11-29T16:47:55Z

GDX Files

2012-11-29T16:47:36Z

GDX Files

← Older revision		Revision as of 18:47, 29 November 2012
Line 163:		Line 163:
	\| <var>format</var>		\| <var>format</var>
	\| The following data formats are supported:		\| The following data formats are supported:
			{\|
	* <code>1</code> - short		\|-
	* <code>2</code> - int		\| <code>1</code> \|\| short
	* <code>3</code> - float		\| <code>2</code> \|\| int
	* <code>4</code> - double		\| <code>3</code> \|\| float
			\| <code>4</code> \|\| double
			\|}

	Note that if the file <var>fileName</var> does not exist, then this parameter is mandatory.		Note that if the file <var>fileName</var> does not exist, then this parameter is mandatory.

2012-11-22T18:22:54Z

File System Items (Dummy Files)

← Older revision		Revision as of 20:22, 22 November 2012
Line 20:		Line 20:
	\|}		\|}

	== File System Items (Dummy Files) ==		== <span id="File_System_Items">File System Items (Dummy Files)</span> ==

	The following command will create a dummy file item, also called file system item. Such dummy files do not represent actual disk files and, hence, cannot be used for reading and writing to disk. Instead, they allow access to system information ''about'' files and directories.		The following command will create a dummy file item, also called file system item. Such dummy files do not represent actual disk files and, hence, cannot be used for reading and writing to disk. Instead, they allow access to system information ''about'' files and directories.

2012-11-21T12:52:28Z

List File Items (Searching for Files and Directories)

← Older revision		Revision as of 14:52, 21 November 2012
Line 32:		Line 32:
	\|}		\|}

	== <span id="~~ListFileItems~~">List File Items (Searching for Files and Directories)</span> ==		== <span id="List_File_Items">List File Items (Searching for Files and Directories)</span> ==

	NEW FILE <var>name</var> /List [ /G ]		NEW FILE <var>name</var> /List [ /G ]

2012-11-21T12:51:40Z

List File Items (Searching for Files and Directories)

← Older revision		Revision as of 14:51, 21 November 2012
Line 32:		Line 32:
	\|}		\|}

	== List File Items (Searching for Files and Directories) ==		== <span id="ListFileItems">List File Items (Searching for Files and Directories)</span> ==

	NEW FILE <var>name</var> /List [ /G ]		NEW FILE <var>name</var> /List [ /G ]

2012-11-21T12:51:02Z

File System Items (Dummy Files)

← Older revision		Revision as of 14:51, 21 November 2012
Line 31:		Line 31:
	\| The parameter <var>name</var> is a unique identifier for this item within the shell. If you pass an asterisk, the identifier is automatically generated and stored in the local variable <code>#new</code>.		\| The parameter <var>name</var> is a unique identifier for this item within the shell. If you pass an asterisk, the identifier is automatically generated and stored in the local variable <code>#new</code>.
	\|}		\|}

			== List File Items (Searching for Files and Directories) ==

	NEW FILE <var>name</var> /List [ /G ]		NEW FILE <var>name</var> /List [ /G ]

2012-11-19T10:40:26Z

← Older revision		Revision as of 12:40, 19 November 2012
Line 26:		Line 26:
	NEW FILE <var>name</var> /File [ /G ]		NEW FILE <var>name</var> /File [ /G ]

	Create a file item that can be used for file-system functions (<code>STATUS</code>, <code>RENAME</code> (=move), <code>COPY</code>, <code>DELETE</code>), but cannot access the content of a file.		Create a file item that can be used for file-system functions ([[Programmer_Guide/Shell_Items/File/SET_FILE#STATUS\|<code>STATUS</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#RENAME_and_COPY\|<code>RENAME</code>]] (=move), [[Programmer_Guide/Shell_Items/File/SET_FILE#RENAME_and_COPY\|<code>COPY</code>]], [[Programmer_Guide/Shell_Items/File/SET_FILE#DELETE\|<code>DELETE</code>)]], but cannot access the content of a file.
	{\|		{\|
	\| <var>name</var>		\| <var>name</var>

2012-11-19T10:38:23Z

General Options

← Older revision		Revision as of 12:38, 19 November 2012
Line 11:		Line 11:

	The following options are available for all <code>NEW FILE</code> commands.		The following options are available for all <code>NEW FILE</code> commands.

	{\|		{\|
	\|-		\|-
	\| <code>/G</code>		\| <code>/G</code>
	\| turns automatic garbage collection on. If specified, the item is automatically deleted when exiting the macro.		\| turns automatic garbage collection on. If specified, the item is automatically deleted when exiting the respective execution context (macro).
	\|-		\|-
	\| <code>/I</code>		\| <code>/I</code>