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

public Class CRYPTPROTECT_PROMPTSTRUCT

extends Struct<CRYPTPROTECT_PROMPTSTRUCT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Provides the text of a prompt and information about when and where that prompt is to be displayed when using the Crypt32#CryptProtectData and Crypt32#CryptUnprotectData functions.

Layout


struct CRYPTPROTECT_PROMPTSTRUCT {
    DWORD cbSize;
    DWORD dwPromptFlags;
    HWND hwndApp;
    LPCWSTR szPrompt;
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CBSIZE

The struct member offsets.

public static final int
DWPROMPTFLAGS

The struct member offsets.

public static final int
HWNDAPP

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SZPROMPT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CRYPTPROTECT_PROMPTSTRUCT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CRYPTPROTECT_PROMPTSTRUCT
calloc()

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated with memCalloc.

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

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

public int
cbSize()

the size, in bytes, of this structure

public CRYPTPROTECT_PROMPTSTRUCT
cbSize(int value)

Sets the specified value to the cbSize field.

public CRYPTPROTECT_PROMPTSTRUCT
cbSize$Default()

Sets the default value to the cbSize field.

protected CRYPTPROTECT_PROMPTSTRUCT
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 CRYPTPROTECT_PROMPTSTRUCT
create()

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated with BufferUtils.

public static CRYPTPROTECT_PROMPTSTRUCT
create(long address)

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance for the specified memory address.

public static CRYPTPROTECT_PROMPTSTRUCT
createSafe(long address)

Like create, but returns null if address is NULL.

public int
dwPromptFlags()

flags that indicate when prompts to the user are to be displayed.

public CRYPTPROTECT_PROMPTSTRUCT
dwPromptFlags(int value)

Sets the specified value to the dwPromptFlags field.

public long
hwndApp()

window handle to the parent window

public CRYPTPROTECT_PROMPTSTRUCT
hwndApp(long value)

Sets the specified value to the hwndApp field.

public static CRYPTPROTECT_PROMPTSTRUCT
malloc()

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated with memAlloc.

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

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated on the specified MemoryStack.

public static int
ncbSize(long struct)

Unsafe version of cbSize.

public static void
ncbSize(long struct, int value)

Unsafe version of cbSize.

public static int
ndwPromptFlags(long struct)

Unsafe version of dwPromptFlags.

public static void
ndwPromptFlags(long struct, int value)

Unsafe version of dwPromptFlags.

public static long
nhwndApp(long struct)

Unsafe version of hwndApp.

public static void
nhwndApp(long struct, long value)

Unsafe version of hwndApp.

public static ByteBuffer
nszPrompt(long struct)

Unsafe version of szPrompt.

public static void
nszPrompt(long struct, ByteBuffer value)

Unsafe version of szPrompt.

public static String
nszPromptString(long struct)

Unsafe version of szPromptString.

public CRYPTPROTECT_PROMPTSTRUCT
set(int cbSize, int dwPromptFlags, long hwndApp, ByteBuffer szPrompt)

Initializes this struct with the specified values.

public CRYPTPROTECT_PROMPTSTRUCT

Returns:

this struct
set(CRYPTPROTECT_PROMPTSTRUCT
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 ByteBuffer
szPrompt()

a string containing the text of a prompt to be displayed

public CRYPTPROTECT_PROMPTSTRUCT
szPrompt(ByteBuffer value)

Sets the address of the specified encoded string to the szPrompt field.

public String
szPromptString()

a string containing the text of a prompt to be displayed

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.

CBSIZEback to summary
public static final int CBSIZE

The struct member offsets.

DWPROMPTFLAGSback to summary
public static final int DWPROMPTFLAGS

The struct member offsets.

HWNDAPPback to summary
public static final int HWNDAPP

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SZPROMPTback to summary
public static final int SZPROMPT

The struct member offsets.

Constructor Detail

CRYPTPROTECT_PROMPTSTRUCTback to summary
protected CRYPTPROTECT_PROMPTSTRUCT(long address, ByteBuffer container)
CRYPTPROTECT_PROMPTSTRUCTback to summary
public CRYPTPROTECT_PROMPTSTRUCT(ByteBuffer container)

Creates a CRYPTPROTECT_PROMPTSTRUCT 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

callocback to summary
public static CRYPTPROTECT_PROMPTSTRUCT calloc()

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

callocback to summary
public static CRYPTPROTECT_PROMPTSTRUCT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

cbSizeback to summary
public int cbSize()

the size, in bytes, of this structure

Annotations
@NativeType:DWORD
cbSizeback to summary
public CRYPTPROTECT_PROMPTSTRUCT cbSize(int value)

Sets the specified value to the cbSize field.

cbSize$Defaultback to summary
public CRYPTPROTECT_PROMPTSTRUCT cbSize$Default()

Sets the default value to the cbSize field.

createback to summary
protected CRYPTPROTECT_PROMPTSTRUCT 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 CRYPTPROTECT_PROMPTSTRUCT create()

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated with BufferUtils.

createback to summary
public static CRYPTPROTECT_PROMPTSTRUCT create(long address)

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance for the specified memory address.

createSafeback to summary
public static CRYPTPROTECT_PROMPTSTRUCT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dwPromptFlagsback to summary
public int dwPromptFlags()

flags that indicate when prompts to the user are to be displayed. One or more of:

Crypt32#CRYPTPROTECT_PROMPT_ON_UNPROTECTCrypt32#CRYPTPROTECT_PROMPT_ON_PROTECT
Annotations
@NativeType:DWORD
dwPromptFlagsback to summary
public CRYPTPROTECT_PROMPTSTRUCT dwPromptFlags(int value)

Sets the specified value to the dwPromptFlags field.

hwndAppback to summary
public long hwndApp()

window handle to the parent window

Annotations
@NativeType:HWND
hwndAppback to summary
public CRYPTPROTECT_PROMPTSTRUCT hwndApp(long value)

Sets the specified value to the hwndApp field.

mallocback to summary
public static CRYPTPROTECT_PROMPTSTRUCT malloc()

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

mallocback to summary
public static CRYPTPROTECT_PROMPTSTRUCT malloc(MemoryStack stack)

Returns a new CRYPTPROTECT_PROMPTSTRUCT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

ncbSizeback to summary
public static int ncbSize(long struct)

Unsafe version of cbSize.

ncbSizeback to summary
public static void ncbSize(long struct, int value)

Unsafe version of cbSize.

ndwPromptFlagsback to summary
public static int ndwPromptFlags(long struct)

Unsafe version of dwPromptFlags.

ndwPromptFlagsback to summary
public static void ndwPromptFlags(long struct, int value)

Unsafe version of dwPromptFlags.

nhwndAppback to summary
public static long nhwndApp(long struct)

Unsafe version of hwndApp.

nhwndAppback to summary
public static void nhwndApp(long struct, long value)

Unsafe version of hwndApp.

nszPromptback to summary
public static ByteBuffer nszPrompt(long struct)

Unsafe version of szPrompt.

nszPromptback to summary
public static void nszPrompt(long struct, ByteBuffer value)

Unsafe version of szPrompt.

nszPromptStringback to summary
public static String nszPromptString(long struct)

Unsafe version of szPromptString.

setback to summary
public CRYPTPROTECT_PROMPTSTRUCT set(int cbSize, int dwPromptFlags, long hwndApp, ByteBuffer szPrompt)

Initializes this struct with the specified values.

setback to summary
public CRYPTPROTECT_PROMPTSTRUCT set(CRYPTPROTECT_PROMPTSTRUCT src)

Copies the specified struct data to this struct.

Parameters
src:CRYPTPROTECT_PROMPTSTRUCT

the source struct

Returns:CRYPTPROTECT_PROMPTSTRUCT

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
szPromptback to summary
public ByteBuffer szPrompt()

a string containing the text of a prompt to be displayed

Annotations
@NativeType:LPCWSTR
szPromptback to summary
public CRYPTPROTECT_PROMPTSTRUCT szPrompt(ByteBuffer value)

Sets the address of the specified encoded string to the szPrompt field.

szPromptStringback to summary
public String szPromptString()

a string containing the text of a prompt to be displayed

Annotations
@NativeType:LPCWSTR
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate