Kernel32CreateFileA(String, Int32, FileShare, IntPtr, FileMode, CreateFileFlags, IntPtr) Method

[DllImportAttribute("Kernel32.dll", CharSet = CharSet.Ansi, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
public static SafeFileHandle CreateFileA(
	string filepath,
	int access,
	FileShare share,
	IntPtr securityAttributes,
	FileMode creationDisposition,
	CreateFileFlags flags,
	IntPtr templateFile
)

<DllImportAttribute("Kernel32.dll", CharSet := CharSet.Ansi, BestFitMapping := false, 
	ThrowOnUnmappableChar := true, SetLastError := true>]
Public Shared Function CreateFileA ( 
	filepath As String,
	access As Integer,
	share As FileShare,
	securityAttributes As IntPtr,
	creationDisposition As FileMode,
	flags As CreateFileFlags,
	templateFile As IntPtr
) As SafeFileHandle

Dim filepath As String
Dim access As Integer
Dim share As FileShare
Dim securityAttributes As IntPtr
Dim creationDisposition As FileMode
Dim flags As CreateFileFlags
Dim templateFile As IntPtr

Dim returnValue As SafeFileHandle

returnValue = Kernel32.CreateFileA(filepath, 
	access, share, securityAttributes, 
	creationDisposition, flags, templateFile)

public:
[DllImportAttribute(L"Kernel32.dll", CharSet = CharSet::Ansi, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
static SafeFileHandle^ CreateFileA(
	String^ filepath, 
	int access, 
	FileShare share, 
	IntPtr securityAttributes, 
	FileMode creationDisposition, 
	CreateFileFlags flags, 
	IntPtr templateFile
)

[<DllImportAttribute("Kernel32.dll", CharSet = CharSet.Ansi, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)>]
static member CreateFileA : 
        filepath : string * 
        access : int * 
        share : FileShare * 
        securityAttributes : IntPtr * 
        creationDisposition : FileMode * 
        flags : CreateFileFlags * 
        templateFile : IntPtr -> SafeFileHandle 

No code example is currently available or this language may not be supported.

Parameters

filepath  String

The name of the file or device to be created or opened.

In the ANSI version of this function (CreateFileA(String, FileAccessRights, FileShare, IntPtr, FileMode, CreateFileFlags, IntPtr)), the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, call the Unicode version of the function (CreateFileW(String, FileAccessRights, FileShare, IntPtr, FileMode, CreateFileFlags, IntPtr)) and prepend "\\?\" to the path, for example: CreateFileW("\\?\C:\Very Long Path\File.txt")

access  Int32

The requested access to the file or device, which can be summarized as read, write, both or neither zero.

share  FileShare

The requested sharing mode of the file or device, which can be read, write, both, delete, all of these, or none (refer to the following table).

Access requests to attributes or extended attributes are not affected by this flag.

securityAttributes  IntPtr

A pointer to a SECURITY_ATTRIBUTES structure that contains two separate but related data members: an optional security descriptor, and a Boolean value that determines whether the returned handle can be inherited by child processes.

creationDisposition  FileMode

An action to take on a file or device that exists or does not exist.

flags  CreateFileFlags

The file or device flags.

templateFile  IntPtr

A valid handle to a template file with the GENERIC_READ access right.

The template file supplies file attributes and extended attributes for the file that is being created.

Return Value

If the function fails, the return value is a INVALID_HANDLE_VALUE value (IntPtr(-1)).

To get extended error information, call GetLastWin32Error.

Reference