Top Description Inners Fields Constructors Methods
org.lwjgl.system.windows

public Class SECURITY_ATTRIBUTES

extends Struct<SECURITY_ATTRIBUTES>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable. This structure provides security settings for objects created by various functions, such as CreateFile, CreatePipe, CreateProcess, RegCreateKeyEx, or RegSaveKeyEx.

Layout


struct SECURITY_ATTRIBUTES {
    DWORD nLength;
    LPVOID lpSecurityDescriptor;
    BOOL bInheritHandle;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BINHERITHANDLE

The struct member offsets.

public static final int
LPSECURITYDESCRIPTOR

The struct member offsets.

public static final int
NLENGTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
SECURITY_ATTRIBUTES(long address, ByteBuffer container)

public
SECURITY_ATTRIBUTES(ByteBuffer container)

Creates a SECURITY_ATTRIBUTES instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public boolean
bInheritHandle()

specifies whether the returned handle is inherited when a new process is created.

public SECURITY_ATTRIBUTES
bInheritHandle(boolean value)

Sets the specified value to the bInheritHandle field.

public static SECURITY_ATTRIBUTES
calloc()

Returns a new SECURITY_ATTRIBUTES instance allocated with memCalloc.

public static SECURITY_ATTRIBUTES.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with memCalloc.

public static SECURITY_ATTRIBUTES
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new SECURITY_ATTRIBUTES instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static SECURITY_ATTRIBUTES.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static SECURITY_ATTRIBUTES
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected SECURITY_ATTRIBUTES
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static SECURITY_ATTRIBUTES
create()

Returns a new SECURITY_ATTRIBUTES instance allocated with BufferUtils.

public static SECURITY_ATTRIBUTES
create(long address)

Returns a new SECURITY_ATTRIBUTES instance for the specified memory address.

public static SECURITY_ATTRIBUTES.Buffer
create(int
the buffer capacity
capacity
)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with BufferUtils.

public static SECURITY_ATTRIBUTES.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a SECURITY_ATTRIBUTES.Buffer instance at the specified memory.

public static SECURITY_ATTRIBUTES
createSafe(long address)

Like create, but returns null if address is NULL.

public static SECURITY_ATTRIBUTES.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
lpSecurityDescriptor()

a pointer to a SECURITY_DESCRIPTOR structure that controls access to the object.

public SECURITY_ATTRIBUTES
lpSecurityDescriptor(long value)

Sets the specified value to the lpSecurityDescriptor field.

public static SECURITY_ATTRIBUTES
malloc()

Returns a new SECURITY_ATTRIBUTES instance allocated with memAlloc.

public static SECURITY_ATTRIBUTES.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with memAlloc.

public static SECURITY_ATTRIBUTES
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new SECURITY_ATTRIBUTES instance allocated on the specified MemoryStack.

public static SECURITY_ATTRIBUTES.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated on the specified MemoryStack.

public static SECURITY_ATTRIBUTES
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static SECURITY_ATTRIBUTES.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nbInheritHandle(long struct)

Unsafe version of bInheritHandle.

public static void
nbInheritHandle(long struct, int value)

Unsafe version of bInheritHandle.

public int
nLength()

the size, in bytes, of this structure.

public SECURITY_ATTRIBUTES
nLength(int value)

Sets the specified value to the nLength field.

public static long
nlpSecurityDescriptor(long struct)

Unsafe version of lpSecurityDescriptor.

public static void
nlpSecurityDescriptor(long struct, long value)

Unsafe version of lpSecurityDescriptor.

public static int
nnLength(long struct)

Unsafe version of nLength.

public static void
nnLength(long struct, int value)

Unsafe version of nLength.

public SECURITY_ATTRIBUTES
set(int nLength, long lpSecurityDescriptor, boolean bInheritHandle)

Initializes this struct with the specified values.

public SECURITY_ATTRIBUTES

Returns:

this struct
set
(SECURITY_ATTRIBUTES
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BINHERITHANDLEback to summary
public static final int BINHERITHANDLE

The struct member offsets.

LPSECURITYDESCRIPTORback to summary
public static final int LPSECURITYDESCRIPTOR

The struct member offsets.

NLENGTHback to summary
public static final int NLENGTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

SECURITY_ATTRIBUTESback to summary
protected SECURITY_ATTRIBUTES(long address, ByteBuffer container)
SECURITY_ATTRIBUTESback to summary
public SECURITY_ATTRIBUTES(ByteBuffer container)

Creates a SECURITY_ATTRIBUTES instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

bInheritHandleback to summary
public boolean bInheritHandle()

specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.

Annotations
@NativeType:BOOL
bInheritHandleback to summary
public SECURITY_ATTRIBUTES bInheritHandle(boolean value)

Sets the specified value to the bInheritHandle field.

callocback to summary
public static SECURITY_ATTRIBUTES calloc()

Returns a new SECURITY_ATTRIBUTES instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static SECURITY_ATTRIBUTES.Buffer calloc(int capacity)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SECURITY_ATTRIBUTES calloc(MemoryStack stack)

Returns a new SECURITY_ATTRIBUTES instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static SECURITY_ATTRIBUTES.Buffer calloc(int capacity, MemoryStack stack)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static SECURITY_ATTRIBUTES callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static SECURITY_ATTRIBUTES callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static SECURITY_ATTRIBUTES.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static SECURITY_ATTRIBUTES.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected SECURITY_ATTRIBUTES create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static SECURITY_ATTRIBUTES create()

Returns a new SECURITY_ATTRIBUTES instance allocated with BufferUtils.

createback to summary
public static SECURITY_ATTRIBUTES create(long address)

Returns a new SECURITY_ATTRIBUTES instance for the specified memory address.

createback to summary
public static SECURITY_ATTRIBUTES.Buffer create(int capacity)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static SECURITY_ATTRIBUTES.Buffer create(long address, int capacity)

Create a SECURITY_ATTRIBUTES.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SECURITY_ATTRIBUTES createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static SECURITY_ATTRIBUTES.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
lpSecurityDescriptorback to summary
public long lpSecurityDescriptor()

a pointer to a SECURITY_DESCRIPTOR structure that controls access to the object. If the value of this member is NULL, the object is assigned the default security descriptor associated with the access token of the calling process. This is not the same as granting access to everyone by assigning a NULL discretionary access control list (DACL). By default, the default DACL in the access token of a process allows access only to the user represented by the access token.

Annotations
@NativeType:LPVOID
lpSecurityDescriptorback to summary
public SECURITY_ATTRIBUTES lpSecurityDescriptor(long value)

Sets the specified value to the lpSecurityDescriptor field.

mallocback to summary
public static SECURITY_ATTRIBUTES malloc()

Returns a new SECURITY_ATTRIBUTES instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static SECURITY_ATTRIBUTES.Buffer malloc(int capacity)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SECURITY_ATTRIBUTES malloc(MemoryStack stack)

Returns a new SECURITY_ATTRIBUTES instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static SECURITY_ATTRIBUTES.Buffer malloc(int capacity, MemoryStack stack)

Returns a new SECURITY_ATTRIBUTES.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static SECURITY_ATTRIBUTES mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static SECURITY_ATTRIBUTES mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static SECURITY_ATTRIBUTES.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static SECURITY_ATTRIBUTES.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nbInheritHandleback to summary
public static int nbInheritHandle(long struct)

Unsafe version of bInheritHandle.

nbInheritHandleback to summary
public static void nbInheritHandle(long struct, int value)

Unsafe version of bInheritHandle.

nLengthback to summary
public int nLength()

the size, in bytes, of this structure. Set this value to SIZEOF.

Annotations
@NativeType:DWORD
nLengthback to summary
public SECURITY_ATTRIBUTES nLength(int value)

Sets the specified value to the nLength field.

nlpSecurityDescriptorback to summary
public static long nlpSecurityDescriptor(long struct)

Unsafe version of lpSecurityDescriptor.

nlpSecurityDescriptorback to summary
public static void nlpSecurityDescriptor(long struct, long value)

Unsafe version of lpSecurityDescriptor.

nnLengthback to summary
public static int nnLength(long struct)

Unsafe version of nLength.

nnLengthback to summary
public static void nnLength(long struct, int value)

Unsafe version of nLength.

setback to summary
public SECURITY_ATTRIBUTES set(int nLength, long lpSecurityDescriptor, boolean bInheritHandle)

Initializes this struct with the specified values.

setback to summary
public SECURITY_ATTRIBUTES set(SECURITY_ATTRIBUTES src)

Copies the specified struct data to this struct.

Parameters
src:SECURITY_ATTRIBUTES

the source struct

Returns:SECURITY_ATTRIBUTES

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.system.windows back to summary

public Class SECURITY_ATTRIBUTES.Buffer

extends StructBuffer<SECURITY_ATTRIBUTES, SECURITY_ATTRIBUTES.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of SECURITY_ATTRIBUTES structs.

Field Summary

Modifier and TypeField and Description
private static final SECURITY_ATTRIBUTES

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SECURITY_ATTRIBUTES.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the value of the SECURITY_ATTRIBUTES#bInheritHandle field.
bInheritHandle
()

public SECURITY_ATTRIBUTES.Buffer
bInheritHandle(boolean value)

Sets the specified value to the SECURITY_ATTRIBUTES#bInheritHandle field.

protected SECURITY_ATTRIBUTES
public long
public SECURITY_ATTRIBUTES.Buffer
lpSecurityDescriptor(long value)

Sets the specified value to the SECURITY_ATTRIBUTES#lpSecurityDescriptor field.

public int

Returns:

the value of the SECURITY_ATTRIBUTES#nLength field.
nLength
()

public SECURITY_ATTRIBUTES.Buffer
nLength(int value)

Sets the specified value to the SECURITY_ATTRIBUTES#nLength field.

protected SECURITY_ATTRIBUTES.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SECURITY_ATTRIBUTES ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new SECURITY_ATTRIBUTES.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by SECURITY_ATTRIBUTES#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bInheritHandleback to summary
public boolean bInheritHandle()
Returns:boolean

the value of the SECURITY_ATTRIBUTES#bInheritHandle field.

Annotations
@NativeType:BOOL
bInheritHandleback to summary
public SECURITY_ATTRIBUTES.Buffer bInheritHandle(boolean value)

Sets the specified value to the SECURITY_ATTRIBUTES#bInheritHandle field.

getElementFactoryback to summary
protected SECURITY_ATTRIBUTES getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
lpSecurityDescriptorback to summary
public long lpSecurityDescriptor()
Returns:long

the value of the SECURITY_ATTRIBUTES#lpSecurityDescriptor field.

Annotations
@NativeType:LPVOID
lpSecurityDescriptorback to summary
public SECURITY_ATTRIBUTES.Buffer lpSecurityDescriptor(long value)

Sets the specified value to the SECURITY_ATTRIBUTES#lpSecurityDescriptor field.

nLengthback to summary
public int nLength()
Returns:int

the value of the SECURITY_ATTRIBUTES#nLength field.

Annotations
@NativeType:DWORD
nLengthback to summary
public SECURITY_ATTRIBUTES.Buffer nLength(int value)

Sets the specified value to the SECURITY_ATTRIBUTES#nLength field.

selfback to summary
protected SECURITY_ATTRIBUTES.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override