Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

fopen (msvcrt)
 
.
Summary
Summary

C# Signature:

[DllImport("msvcrt.dll", CallingConvention=CallingConvention.Cdecl, CharSet=CharSet.Ansi, SetLastError=true)]
public static extern Int32 fopen_s(out IntPtr pFile, String filename, String mode);
public static extern IntPtr fopen(String filename, String mode);
[DllImport("msvcrt.dll", CallingConvention=CallingConvention.Cdecl, CharSet=CharSet.Unicode, SetLastError=true)]
public static extern Int32 _wfopen_s(out IntPtr pFile, String filename, String mode);
public static extern IntPtr _wfopen(String filename, String mode);

VB Signature:

<DllImport("msvcrt.dll", CallingConvention:=CallingConvention.Cdecl, CharSet:=CharSet.Ansi, SetLastError:=True)> _
Public Shared Function fopen_s(ByRef pFile As IntPtr, ByVal filename As String, ByVal mode As String) As Int32
Public Shared Function fopen(ByVal filename As String, ByVal mode As String) As IntPtr
End Function
<DllImport("msvcrt.dll", CallingConvention:=CallingConvention.Cdecl, CharSet:=CharSet.Unicode, SetLastError:=True)> _
Public Shared Function _wfopen_s(ByRef pFile As IntPtr, ByVal filename As String, ByVal mode As String) As Int32
Public Shared Function _wfopen(ByVal filename As String, ByVal mode As String) As IntPtr
End Function

Alternative Managed API:

System.IO.FileStream

Notes:

It is advisable to use _wfopen_s whenever possible. fopen_s supports Unicode but requires additional "help"; you must add a "ccs=encoding" parameter to the mode parameter. Valid encoding values are UNICODE, UTF-8, and UTF-16LE; if ccs is not provided, fopen_s falls back to ASCII (it is unknown what happens if an invalid value is passed).

Use _wfopen whenever possible; fopen doesn't support Unicode.

Tips & Tricks:

Please add some!

Sample Code:

Opening a Unicode file (example.txt) for writing (C#):

// "incorrect" way
IntPtr file;
if (!fopen_s(out file, "example.txt", "w, ccs=UNICODE"))
     // fail
else
     // success

// "correct" way
IntPtr file;
if (!_wfopen_s(out file, "example.txt", "w"))
     // fail
else
     // success

Please add some!

See Also:

fopen (includes _wfopen)

Documentation
fopen_s on MSDN
Documentation
fopen on MSDN

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions