Difference between revisions of "MCS DeleteDirectory"

From WikiPrizm
Jump to navigationJump to search
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:MCS_DeleteDirectory}}
 
{{DISPLAYTITLE:MCS_DeleteDirectory}}
== Synopsis ==
+
{{syscall
'''Header:''' mcs_syscalls.h
+
| name = MCS_DeleteDirectory
 
+
| header = fxcg/file.h
'''Syscall:'''
+
| index = 0x1516
 
+
| signature = int MCS_DeleteDirectory(unsigned char* dir)
'''Function declaration:''' int MCS_DeleteDirectory(unsigned char* dir);
+
| synopsis = Deletes a directory from main memory.
 
+
| parameters =
Delete the passed in directory from main memory.
+
* '''dir''' - The name of the directory to delete in letters, numbers, and symbols.
 
+
| returns = * 0 for success;
=== Inputs ===
+
* 0xF0 if '''dir''' is null or length of *dir is 0;
* ''unsigned char*'' '''dir''' - The name of the directory.
+
* 0x40 if directory '''dir''' does not exist;
 
+
* 0x45 if the directory contains items (these must be deleted beforehand with [[MCSDelVar2]]);
=== Outputs ===
+
* 0x46 if *dir is "@APLWORK" or "main" (system folders which can't be deleted);
* '''0''' - Success
+
* 0x47 if certain flags for directory '''dir''' are set.
* '''other''' - Failure
+
| comments = Note that empty folders aren't seen by add-ins.
 
+
}}
== Comments ==
+
[[Category:Syscalls:MCS]]
Output could be error codes. Still needs investigation.
 
 
 
[[Category:Syscalls]][[Category:Main_Memory]]
 

Latest revision as of 08:48, 30 July 2014


Synopsis

Header: fxcg/file.h
Syscall index: 0x1516
Function signature: int MCS_DeleteDirectory(unsigned char* dir)

Deletes a directory from main memory.

Parameters

  • dir - The name of the directory to delete in letters, numbers, and symbols.

Returns

  • 0 for success;
  • 0xF0 if dir is null or length of *dir is 0;
  • 0x40 if directory dir does not exist;
  • 0x45 if the directory contains items (these must be deleted beforehand with MCSDelVar2);
  • 0x46 if *dir is "@APLWORK" or "main" (system folders which can't be deleted);
  • 0x47 if certain flags for directory dir are set.

Comments

Note that empty folders aren't seen by add-ins.