DEVICEDIALOGDATA2 structure

Defines the data needed to call a device dialog.

Syntax

typedef struct {
  DWORD     cbSize;
  IWiaItem2 *pIWiaItemRoot;
  DWORD     dwFlags;
  HWND      hwndParent;
  BSTR      bstrFolderName;
  BSTR      bstrFilename;
  LONG      lNumFiles;
  BSTR      *pbstrFilePaths;
  IWiaItem2 *ppWiaItem;
} DEVICEDIALOGDATA2;

Members

cbSize

Type: DWORD

Specifies the size of this structure in bytes.

pIWiaItemRoot

Type: IWiaItem2*

Points to an IWiaItem2 interface that represents the valid root item in the application item tree.

dwFlags

Type: DWORD

Specifies a set of flags that control the dialog box's operation. Can be set to any of the following values:

Flag Meaning
0 Default behavior.
WIA_DEVICE_DIALOG_SINGLE_IMAGE Restrict image selection to a single image in the device image acquisition dialog box.
WIA_DEVICE_DIALOG_USE_COMMON_UI Use the system UI, if available, rather than the vendor-supplied UI. If the system UI is not available, the vendor UI is used. If neither UI is available, the function returns E_NOTIMPL.

 

hwndParent

Type: HWND

Specifies the handle to the parent window of the dialog.

bstrFolderName

Type: BSTR

Specifies the folder name where the files are transferred.

bstrFilename

Type: BSTR

Specifies the filename template to be used for files transferred from WIA items to the destination folder designated by bstrFolderName. An arbitrary number of unique file names can be created by appending additional characters to the file name template.

lNumFiles

Type: LONG

Receives the number of strings written to the pbstrFilePaths array.

pbstrFilePaths

Type: BSTR*

Pointer to an array of BSTR pointers. Each array element points to a BSTR that contains the destination name of a file that was successfully transferred to the folder identified by bstrFolderName. The method must allocate the storage for this member.

ppWiaItem

Type: IWiaItem2*

Pointer to the IWiaItem2 interface of the WIA item that transfers data to the file or files named in the pbstrFilePaths array.

Requirements

Requirement Value
Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
Header
Wiadefd.h