org.rococoa.cocoa.carboncore
Class FSFileOperationClientContext

java.lang.Object
  com.sun.jna.Structure
      com.ochafik.lang.jnaerator.runtime.Structure<FSFileOperationClientContext,FSFileOperationClientContext.ByValue,FSFileOperationClientContext.ByReference>
          org.rococoa.cocoa.carboncore.FSFileOperationClientContext

All Implemented Interfaces:

StructureType, StructureTypeDependent, Comparable<Structure<FSFileOperationClientContext,FSFileOperationClientContext.ByValue,FSFileOperationClientContext.ByReference>>

Direct Known Subclasses:

FSFileOperationClientContext.ByReference, FSFileOperationClientContext.ByValue

public class FSFileOperationClientContext
extends Structure<FSFileOperationClientContext,FSFileOperationClientContext.ByValue,FSFileOperationClientContext.ByReference>

FSFileOperationClientContext

Discussion:
Structure containing the user-defined data and callbacks for
FSFileOperation client contextual data.
native declaration : /System/Library/Frameworks/CoreServices.framework/Versions/Current/Frameworks/CarbonCore.framework/Headers/Files.h:5417
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static class	FSFileOperationClientContext.ByReference
static class	FSFileOperationClientContext.ByValue

Field Summary

CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack	copyDescription The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes.
Pointer	info An arbitrary pointer to client-defined data, which can be associated with the operation and is passed to the callbacks.
CoreFoundationLibrary.CFAllocatorReleaseCallBack	release The callback used to remove a retain previously added for the operation on the info pointer.
CoreFoundationLibrary.CFAllocatorRetainCallBack	retain The callback used to add a retain for the operation on the info pointer for the life of the operation, and may be used for temporary references the operation needs to take.
NativeLong	version The version number of the structure type being passed in as a parameter to FSCopyObjectAsync or FSMoveObjectAsync function.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE

Constructor Summary

FSFileOperationClientContext()

FSFileOperationClientContext(NativeLong version, Pointer info, CoreFoundationLibrary.CFAllocatorRetainCallBack retain, CoreFoundationLibrary.CFAllocatorReleaseCallBack release, CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Method Summary

static FSFileOperationClientContext[]

newArray(int arrayLength)

Methods inherited from class com.ochafik.lang.jnaerator.runtime.Structure

byReference, byValue, castToArray, castToArray, castToArray, castToReferenceArray, castToReferenceArray, castToValueArray, castToValueArray, clone, compareTo, newArray, read, setDependency, toArray, toArray, toArray, toReferenceArray, toReferenceArray, toValueArray, toValueArray, use, use, use, use, write

Methods inherited from class com.sun.jna.Structure

autoRead, autoRead, autoWrite, autoWrite, clear, equals, getAutoRead, getAutoWrite, getPointer, hashCode, newInstance, readField, setAutoRead, setAutoSynch, setAutoWrite, size, toString, writeField, writeField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ochafik.lang.jnaerator.runtime.StructureType

getPointer, size

Field Detail

version

public NativeLong version

The version number of the structure type being passed in as a
parameter to FSCopyObjectAsync or FSMoveObjectAsync function.
Valid version number is currently 0.
C type : CFIndex

info

public Pointer info

An arbitrary pointer to client-defined data, which can be
associated with the operation and is passed to the callbacks.
C type : void*

retain

public CoreFoundationLibrary.CFAllocatorRetainCallBack retain

The callback used to add a retain for the operation on the info
pointer for the life of the operation, and may be used for
temporary references the operation needs to take. This callback
returns the actual info pointer to store in the operation, almost
always just the pointer passed as the parameter.
C type : CFAllocatorRetainCallBack

release

public CoreFoundationLibrary.CFAllocatorReleaseCallBack release

The callback used to remove a retain previously added for the
operation on the info pointer.
C type : CFAllocatorReleaseCallBack

copyDescription

public CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription

The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This is used by the CFCopyDescription()
function.
C type : CFAllocatorCopyDescriptionCallBack

Constructor Detail

FSFileOperationClientContext

public FSFileOperationClientContext()

FSFileOperationClientContext

public FSFileOperationClientContext(NativeLong version,
                                    Pointer info,
                                    CoreFoundationLibrary.CFAllocatorRetainCallBack retain,
                                    CoreFoundationLibrary.CFAllocatorReleaseCallBack release,
                                    CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Parameters:

version - The version number of the structure type being passed in as a
parameter to FSCopyObjectAsync or FSMoveObjectAsync function.
Valid version number is currently 0.
C type : CFIndex

info - An arbitrary pointer to client-defined data, which can be
associated with the operation and is passed to the callbacks.
C type : void*

retain - The callback used to add a retain for the operation on the info
pointer for the life of the operation, and may be used for
temporary references the operation needs to take. This callback
returns the actual info pointer to store in the operation, almost
always just the pointer passed as the parameter.
C type : CFAllocatorRetainCallBack

release - The callback used to remove a retain previously added for the
operation on the info pointer.
C type : CFAllocatorReleaseCallBack

copyDescription - The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This is used by the CFCopyDescription()
function.
C type : CFAllocatorCopyDescriptionCallBack

Method Detail

newArray

public static FSFileOperationClientContext[] newArray(int arrayLength)