FILE_ShellDelete

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > File > FILE: functions working on files >

FILE_ShellDelete

 

Description

 

Delete a file using operating system file operations. File will be placed into recycle bin.

 

Syntax

 

n = FILE_ShellDelete(FullFileName)

 

Returns

 

Number. Zero if successful, otherwise nonzero.

 

Parameters

 

Name

Type

Optional

Meaning

FullFileName

String

No

A string representing one or more source file names.

These names should be fully-qualified paths to prevent unexpected results.

Standard Microsoft MS-DOS wildcard characters, such as "*", are permitted only in the file-name position. Using a wildcard character elsewhere in the string will lead to unpredictable results.

 

Although this member is declared as a single string, it is actually a buffer that can hold multiple null-delimited file names. Each file name is terminated by a single $NUL character. The last file name is automatically terminated with a double $NUL character by thinBasic to indicate the end of the buffer.

 

Remarks

 

Restrictions

 

See also

 

File Module,

 

Examples