nn::fs::TryCreateFile Function

Syntax

Result TryCreateFile(
     const char * pathName,
     s64 size
);

Arguments

Name Description
in pathName Path of the file to create.
in size Size of the file to create.

Return Values

Returns the result of the operation.

Description

Creates a file.

This function returns any error that occurs while it is creating the file.


Note: This function uses a large amount of buffer space on the stack because it converts the path name from a multibyte string into a wide string. Pay careful attention to the stack size.

If file creation fails, a garbage file may have been created. Call the TryDeleteFile function to delete it. If a garbage file has not been created, ResultNotFound is returned.

Which Result values need handling will differ, depending on the archive. For details, see Handling Errors During File and Directory Operations.

Note

After a file has been created with this function, if nothing has been written then in principle the process of reading will return nn::fs::ResultVerificationFailed.
However, if this function is called for save data or expanded save data, then the first 512 bytes (or the entire file if the size is 512 bytes or smaller) are guaranteed to be zero-initialized. By using this and writing to the file in the order (Create file > Write data and flush > Write file signature to front and flush), you can check that the file signature has been loaded correctly and guarantee that the file is written correctly.

Revision History

2011/02/21
Explained that the first 512 bytes are zero-filled.
2010/12/24
Added a Note.
2010/12/22
Added a link to the error handling page.
2010/11/09
Initial version.

CONFIDENTIAL