Top Description Inners Fields
com.sun.jna.platform.win32

public Interface Ntifs

extends WinDef, BaseTSD
Imports
java.util.Arrays, .List, com.sun.jna.Native, .Pointer, .Structure, .Structure.FieldOrder, .Union, com.sun.jna.win32.W32APITypeMapper

Ported from Ntifs.h Microsoft Windows WDK 10
Author
amarcionek[at]gmail.com

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class
public static class
Ntifs.REPARSE_DATA_BUFFER

The REPARSE_DATA_BUFFER structure contains reparse point data for a Microsoft reparse point.

public static class

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
Inherited from com.sun.jna.platform.win32.WinDef:
MAX_PATH

Field Detail

MAXIMUM_REPARSE_DATA_BUFFER_SIZEback to summary
public static final int MAXIMUM_REPARSE_DATA_BUFFER_SIZE
REPARSE_BUFFER_HEADER_SIZEback to summary
public static final int REPARSE_BUFFER_HEADER_SIZE
com.sun.jna.platform.win32 back to summary

public Class Ntifs.GenericReparseBuffer

extends Structure
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.Ntifs.GenericReparseBuffer.ByReference
Annotations
@FieldOrder:DataBuffer

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public byte[]
DataBuffer

Microsoft-defined data for the reparse point.

Inherited from com.sun.jna.Structure:
ALIGN_DEFAULTALIGN_GNUCALIGN_MSVCALIGN_NONECALCULATE_SIZE

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public static int
Inherited from com.sun.jna.Structure:
allocateMemoryallocateMemoryautoAllocateautoReadautoReadautoWriteautoWritecacheTypeInfocalculateSizeclearcreateFieldsOrdercreateFieldsOrdercreateFieldsOrdercreateFieldsOrderdataEqualsdataEqualsensureAllocatedequalsfieldOffsetgetAutoReadgetAutoWritegetFieldListgetFieldOrdergetFieldsgetNativeAlignmentgetNativeSizegetNativeSizegetPointergetStringEncodinggetStructAlignmenthashCodenewInstancenewInstancereadreadFieldreadFieldsetAlignTypesetAutoReadsetAutoSynchsetAutoWritesetStringEncodingsizesortFieldstoArraytoArraytoStringtoStringuseMemoryuseMemorywritewriteFieldwriteFieldwriteField

Field Detail

DataBufferback to summary
public byte[] DataBuffer

Microsoft-defined data for the reparse point.

Note

MAXIMUM_REPARSE_DATA_BUFFER_SIZE is chosen based on documentation

Constructor Detail

GenericReparseBufferback to summary
public GenericReparseBuffer()
GenericReparseBufferback to summary
public GenericReparseBuffer(Pointer memory)
GenericReparseBufferback to summary
public GenericReparseBuffer(String DataBuffer)

Method Detail

sizeOfback to summary
public static int sizeOf()
com.sun.jna.platform.win32 back to summary

public Class Ntifs.GenericReparseBuffer.ByReference

extends GenericReparseBuffer
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
public

Constructor Detail

ByReferenceback to summary
public ByReference()
ByReferenceback to summary
public ByReference(Pointer memory)
com.sun.jna.platform.win32 back to summary

public Class Ntifs.MountPointReparseBuffer

extends Structure
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.Ntifs.MountPointReparseBuffer.ByReference
Annotations
@FieldOrder:SubstituteNameOffset, SubstituteNameLength, PrintNameOffset, PrintNameLength, PathBuffer

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public char[]
PathBuffer

First character of the path string.

public short
PrintNameLength

Length, in bytes, of the print name string.

public short
PrintNameOffset

Offset, in bytes, of the print name string in the PathBuffer array.

public short
SubstituteNameLength

Length, in bytes, of the substitute name string.

public short
SubstituteNameOffset

Offset, in bytes, of the substitute name string in the PathBuffer array.

Inherited from com.sun.jna.Structure:
ALIGN_DEFAULTALIGN_GNUCALIGN_MSVCALIGN_NONECALCULATE_SIZE

Constructor Summary

AccessConstructor and Description
public
public
public
MountPointReparseBuffer(String substituteName, String printName)

public
MountPointReparseBuffer(short SubstituteNameOffset, short SubstituteNameLength, short PrintNameOffset, short PrintNameLength, String PathBuffer)

Method Summary

Modifier and TypeMethod and Description
public static int
Inherited from com.sun.jna.Structure:
allocateMemoryallocateMemoryautoAllocateautoReadautoReadautoWriteautoWritecacheTypeInfocalculateSizeclearcreateFieldsOrdercreateFieldsOrdercreateFieldsOrdercreateFieldsOrderdataEqualsdataEqualsensureAllocatedequalsfieldOffsetgetAutoReadgetAutoWritegetFieldListgetFieldOrdergetFieldsgetNativeAlignmentgetNativeSizegetNativeSizegetPointergetStringEncodinggetStructAlignmenthashCodenewInstancenewInstancereadreadFieldreadFieldsetAlignTypesetAutoReadsetAutoSynchsetAutoWritesetStringEncodingsizesortFieldstoArraytoArraytoStringtoStringuseMemoryuseMemorywritewriteFieldwriteFieldwriteField

Field Detail

PathBufferback to summary
public char[] PathBuffer

First character of the path string. This is followed in memory by the remainder of the string. The path string contains the substitute name string and print name string. The substitute name and print name strings can appear in any order in the PathBuffer. (To locate the substitute name and print name strings in the PathBuffer, use the SubstituteNameOffset, SubstituteNameLength, PrintNameOffset, and PrintNameLength members.)

Note

MAXIMUM_REPARSE_DATA_BUFFER_SIZE is chosen here based on documentation. Because chars are two bytes, the actual array size needs to be divided by 2

PrintNameLengthback to summary
public short PrintNameLength

Length, in bytes, of the print name string. If this string is NULL-terminated, PrintNameLength does not include space for the UNICODE_NULL character.

PrintNameOffsetback to summary
public short PrintNameOffset

Offset, in bytes, of the print name string in the PathBuffer array. Note that this offset must be divided by sizeof(WCHAR) to get the array index.

SubstituteNameLengthback to summary
public short SubstituteNameLength

Length, in bytes, of the substitute name string. If this string is NULL-terminated, SubstituteNameLength does not include space for the UNICODE_NULL character.

SubstituteNameOffsetback to summary
public short SubstituteNameOffset

Offset, in bytes, of the substitute name string in the PathBuffer array. Note that this offset must be divided by sizeof(WCHAR) to get the array index.

Constructor Detail

MountPointReparseBufferback to summary
public MountPointReparseBuffer()
MountPointReparseBufferback to summary
public MountPointReparseBuffer(Pointer memory)
MountPointReparseBufferback to summary
public MountPointReparseBuffer(String substituteName, String printName)
MountPointReparseBufferback to summary
public MountPointReparseBuffer(short SubstituteNameOffset, short SubstituteNameLength, short PrintNameOffset, short PrintNameLength, String PathBuffer)

Method Detail

sizeOfback to summary
public static int sizeOf()
com.sun.jna.platform.win32 back to summary

public Class Ntifs.MountPointReparseBuffer.ByReference

extends MountPointReparseBuffer
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
public

Constructor Detail

ByReferenceback to summary
public ByReference()
ByReferenceback to summary
public ByReference(Pointer memory)
com.sun.jna.platform.win32 back to summary

public Class Ntifs.REPARSE_DATA_BUFFER

extends Structure
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.Ntifs.REPARSE_DATA_BUFFER.ByReference
Annotations
@FieldOrder:ReparseTag, ReparseDataLength, Reserved, u

The REPARSE_DATA_BUFFER structure contains reparse point data for a Microsoft reparse point. (Third-party reparse point owners must use the REPARSE_GUID_DATA_BUFFER structure instead.)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class

Field Summary

Modifier and TypeField and Description
public short
ReparseDataLength

Size, in bytes, of the reparse data in the DataBuffer member.

public int
ReparseTag

Reparse point tag.

public short
Reserved

Length, in bytes, of the unparsed portion of the file name pointed to by the FileName member of the associated file object.

public Ntifs.REPARSE_DATA_BUFFER.REPARSE_UNION
u

Inherited from com.sun.jna.Structure:
ALIGN_DEFAULTALIGN_GNUCALIGN_MSVCALIGN_NONECALCULATE_SIZE

Constructor Summary

AccessConstructor and Description
public
public
REPARSE_DATA_BUFFER(int ReparseTag, short Reserved)

public
REPARSE_DATA_BUFFER(int ReparseTag, short Reserved, Ntifs.SymbolicLinkReparseBuffer symLinkReparseBuffer)

public

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

size of the structure considering the ReparseDataLength size
getSize
()

public void
read()

Overrides com.sun.jna.Structure.read.

Reads the fields of the struct from native memory
public static int
Inherited from com.sun.jna.Structure:
allocateMemoryallocateMemoryautoAllocateautoReadautoReadautoWriteautoWritecacheTypeInfocalculateSizeclearcreateFieldsOrdercreateFieldsOrdercreateFieldsOrdercreateFieldsOrderdataEqualsdataEqualsensureAllocatedequalsfieldOffsetgetAutoReadgetAutoWritegetFieldListgetFieldOrdergetFieldsgetNativeAlignmentgetNativeSizegetNativeSizegetPointergetStringEncodinggetStructAlignmenthashCodenewInstancenewInstancereadFieldreadFieldsetAlignTypesetAutoReadsetAutoSynchsetAutoWritesetStringEncodingsizesortFieldstoArraytoArraytoStringtoStringuseMemoryuseMemorywritewriteFieldwriteFieldwriteField

Field Detail

ReparseDataLengthback to summary
public short ReparseDataLength

Size, in bytes, of the reparse data in the DataBuffer member.

ReparseTagback to summary
public int ReparseTag

Reparse point tag. Must be a Microsoft reparse point tag.

Reservedback to summary
public short Reserved

Length, in bytes, of the unparsed portion of the file name pointed to by the FileName member of the associated file object. For more information about the FileName member, see FILE_OBJECT. This member is only valid for create operations when the I/O fails with STATUS_REPARSE. For all other purposes, such as setting or querying a reparse point for the reparse data, this member is treated as reserved.

uback to summary
public Ntifs.REPARSE_DATA_BUFFER.REPARSE_UNION u

Constructor Detail

REPARSE_DATA_BUFFERback to summary
public REPARSE_DATA_BUFFER()
REPARSE_DATA_BUFFERback to summary
public REPARSE_DATA_BUFFER(int ReparseTag, short Reserved)
REPARSE_DATA_BUFFERback to summary
public REPARSE_DATA_BUFFER(int ReparseTag, short Reserved, Ntifs.SymbolicLinkReparseBuffer symLinkReparseBuffer)
REPARSE_DATA_BUFFERback to summary
public REPARSE_DATA_BUFFER(Pointer memory)

Method Detail

getSizeback to summary
public int getSize()
Returns:int

size of the structure considering the ReparseDataLength size

readback to summary
public void read()

Overrides com.sun.jna.Structure.read.

Doc from com.sun.jna.Structure.read.

Reads the fields of the struct from native memory

Annotations
@Override
sizeOfback to summary
public static int sizeOf()
com.sun.jna.platform.win32 back to summary

public Class Ntifs.REPARSE_DATA_BUFFER.ByReference

extends REPARSE_DATA_BUFFER
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
public

Constructor Detail

ByReferenceback to summary
public ByReference()
ByReferenceback to summary
public ByReference(Pointer memory)
com.sun.jna.platform.win32 back to summary

public Class Ntifs.REPARSE_DATA_BUFFER.REPARSE_UNION

extends Union
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.Ntifs.REPARSE_DATA_BUFFER.REPARSE_UNION.ByReference

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Constructor Summary

AccessConstructor and Description
public
public

Field Detail

genericReparseBufferback to summary
public Ntifs.GenericReparseBuffer genericReparseBuffer
mountPointReparseBufferback to summary
public Ntifs.MountPointReparseBuffer mountPointReparseBuffer
symLinkReparseBufferback to summary
public Ntifs.SymbolicLinkReparseBuffer symLinkReparseBuffer

Constructor Detail

REPARSE_UNIONback to summary
public REPARSE_UNION()
REPARSE_UNIONback to summary
public REPARSE_UNION(Pointer memory)
com.sun.jna.platform.win32 back to summary

public Class Ntifs.REPARSE_DATA_BUFFER.REPARSE_UNION.ByReference

extends REPARSE_UNION
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public

Constructor Detail

ByReferenceback to summary
public ByReference()
com.sun.jna.platform.win32 back to summary

public Class Ntifs.SymbolicLinkReparseBuffer

extends Structure
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.Ntifs.SymbolicLinkReparseBuffer.ByReference
Annotations
@FieldOrder:SubstituteNameOffset, SubstituteNameLength, PrintNameOffset, PrintNameLength, Flags, PathBuffer

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public int
Flags

Used to indicate if the given symbolic link is an absolute or relative symbolic link.

public char[]
PathBuffer

First character of the path string.

public short
PrintNameLength

Length, in bytes, of the print name string.

public short
PrintNameOffset

Offset, in bytes, of the print name string in the PathBuffer array.

public short
SubstituteNameLength

Length, in bytes, of the substitute name string.

public short
SubstituteNameOffset

Offset, in bytes, of the substitute name string in the PathBuffer array.

Inherited from com.sun.jna.Structure:
ALIGN_DEFAULTALIGN_GNUCALIGN_MSVCALIGN_NONECALCULATE_SIZE

Constructor Summary

AccessConstructor and Description
public
public
public
SymbolicLinkReparseBuffer(String substituteName, String printName, int Flags)

public
SymbolicLinkReparseBuffer(short SubstituteNameOffset, short SubstituteNameLength, short PrintNameOffset, short PrintNameLength, int Flags, String PathBuffer)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the print name in a String
getPrintName
()

public String

Returns:

the substitute name in a String
getSubstituteName
()

public static int
Inherited from com.sun.jna.Structure:
allocateMemoryallocateMemoryautoAllocateautoReadautoReadautoWriteautoWritecacheTypeInfocalculateSizeclearcreateFieldsOrdercreateFieldsOrdercreateFieldsOrdercreateFieldsOrderdataEqualsdataEqualsensureAllocatedequalsfieldOffsetgetAutoReadgetAutoWritegetFieldListgetFieldOrdergetFieldsgetNativeAlignmentgetNativeSizegetNativeSizegetPointergetStringEncodinggetStructAlignmenthashCodenewInstancenewInstancereadreadFieldreadFieldsetAlignTypesetAutoReadsetAutoSynchsetAutoWritesetStringEncodingsizesortFieldstoArraytoArraytoStringtoStringuseMemoryuseMemorywritewriteFieldwriteFieldwriteField

Field Detail

Flagsback to summary
public int Flags

Used to indicate if the given symbolic link is an absolute or relative symbolic link. If Flags contains SYMLINK_FLAG_RELATIVE, the symbolic link contained in the PathBuffer array (at offset SubstitueNameOffset) is processed as a relative symbolic link; otherwise, it is processed as an absolute symbolic link.

PathBufferback to summary
public char[] PathBuffer

First character of the path string. This is followed in memory by the remainder of the string. The path string contains the substitute name string and print name string. The substitute name and print name strings can appear in any order in the PathBuffer. (To locate the substitute name and print name strings in the PathBuffer, use the SubstituteNameOffset, SubstituteNameLength, PrintNameOffset, and PrintNameLength members.)

Note

MAXIMUM_REPARSE_DATA_BUFFER_SIZE is chosen here based on documentation. Because chars are two bytes, the actual array size needs to be divided by 2

PrintNameLengthback to summary
public short PrintNameLength

Length, in bytes, of the print name string. If this string is NULL-terminated, PrintNameLength does not include space for the UNICODE_NULL character.

PrintNameOffsetback to summary
public short PrintNameOffset

Offset, in bytes, of the print name string in the PathBuffer array. Note that this offset must be divided by sizeof(WCHAR) to get the array index.

SubstituteNameLengthback to summary
public short SubstituteNameLength

Length, in bytes, of the substitute name string. If this string is NULL-terminated, SubstituteNameLength does not include space for the UNICODE_NULL character.

SubstituteNameOffsetback to summary
public short SubstituteNameOffset

Offset, in bytes, of the substitute name string in the PathBuffer array. Note that this offset must be divided by sizeof(WCHAR) to get the array index.

Constructor Detail

SymbolicLinkReparseBufferback to summary
public SymbolicLinkReparseBuffer()
SymbolicLinkReparseBufferback to summary
public SymbolicLinkReparseBuffer(Pointer memory)
SymbolicLinkReparseBufferback to summary
public SymbolicLinkReparseBuffer(String substituteName, String printName, int Flags)
SymbolicLinkReparseBufferback to summary
public SymbolicLinkReparseBuffer(short SubstituteNameOffset, short SubstituteNameLength, short PrintNameOffset, short PrintNameLength, int Flags, String PathBuffer)

Method Detail

getPrintNameback to summary
public String getPrintName()
Returns:String

the print name in a String

getSubstituteNameback to summary
public String getSubstituteName()
Returns:String

the substitute name in a String

sizeOfback to summary
public static int sizeOf()
com.sun.jna.platform.win32 back to summary

public Class Ntifs.SymbolicLinkReparseBuffer.ByReference

extends SymbolicLinkReparseBuffer
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
public

Constructor Detail

ByReferenceback to summary
public ByReference()
ByReferenceback to summary
public ByReference(Pointer memory)