com.sun.jna.platform.win32
Class ShellAPI.SHFILEOPSTRUCT

java.lang.Object
  com.sun.jna.Structure
      com.sun.jna.platform.win32.ShellAPI.SHFILEOPSTRUCT

Enclosing interface:

ShellAPI

public static class ShellAPI.SHFILEOPSTRUCT
extends Structure

Contains information that the SHFileOperation function uses to perform file operations.

hwnd

public WinNT.HANDLE hwnd

A window handle to the dialog box to display information about the status of the file operation.

wFunc

public int wFunc

An FO_* value that indicates which operation to perform.

pFrom

public WString pFrom

A pointer to one or more source file names, double null-terminated.

pTo

public WString pTo

A pointer to the destination file or directory name.

fFlags

public short fFlags

Flags that control the file operation.

fAnyOperationsAborted

public boolean fAnyOperationsAborted

When the function returns, this member contains TRUE if any file operations were aborted before they were completed; otherwise, FALSE. An operation can be manually aborted by the user through UI or it can be silently aborted by the system if the FOF_NOERRORUI or FOF_NOCONFIRMATION flags were set.

pNameMappings

public Pointer pNameMappings

When the function returns, this member contains a handle to a name mapping object that contains the old and new names of the renamed files. This member is used only if the fFlags member includes the FOF_WANTMAPPINGHANDLE flag.

lpszProgressTitle

public WString lpszProgressTitle

A pointer to the title of a progress dialog box. This is a null-terminated string.

ShellAPI.SHFILEOPSTRUCT

public ShellAPI.SHFILEOPSTRUCT()

getFieldOrder

protected List getFieldOrder()

Description copied from class: Structure

Return this Structure's field names in their proper order. For example,

 protected List getFieldOrder() {
     return Arrays.asList(new String[] { ... });
 }
 

IMPORTANT When deriving from an existing Structure subclass, ensure that you augment the list provided by the superclass, e.g.

 protected List getFieldOrder() {
     List fields = new ArrayList(super.getFieldOrder());
     fields.addAll(Arrays.asList(new String[] { ... }));
     return fields;
 }
 

Field order must be explicitly indicated, since the field order as returned by Class.getFields() is not guaranteed to be predictable.

Specified by:

getFieldOrder in class Structure

encodePaths

public String encodePaths(String[] paths)

Use this to encode pFrom/pTo paths.