WPDデバイスのファイル、フォルダ一覧を取得する - C#

WPDデバイスのファイル、フォルダ一覧を取得するコードを紹介します。

事前準備

こちらの記事を参照して、PortableDeviceApi のCOMオブジェクトをプロジェクトの参照に追加しておきます。

プログラム

Windows Formアプリケーションを作成します。

UI

下図のUIを作成します。フォームにコンボボックスとListViewを1つずつ配置します。

コード

下記のコードを記述します。フォームのLoadイベント以外にコンボボックスのSelectedIndexChangedイベントと、リストビューのDoubleClickイベントを実装します。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using PortableDeviceApiLib;

namespace WpdDemo
{
  public partial class FormMain : Form
  {
    public const uint WPD_OBJECT_ID = 2;
    public const uint WPD_OBJECT_PARENT_ID = 3;
    public const uint WPD_OBJECT_NAME = 4;
    public const uint WPD_OBJECT_CONTENT_TYPE = 7;
    public const uint WPD_OBJECT_SIZE = 11;
    public const uint WPD_OBJECT_ORIGINAL_FILE_NAME = 12;
    public const uint WPD_OBJECT_DATE_CREATED = 18;
    public const uint WPD_OBJECT_DATE_MODIFIED = 19;
            
    public const uint WPD_FUNCTIONAL_OBJECT_CATEGORY = 2;
    public const uint WPD_CLIENT_NAME = 2;
    public const uint WPD_CLIENT_MAJOR_VERSION = 3;
    public const uint WPD_CLIENT_MINOR_VERSION = 4;
    public const uint WPD_CLIENT_REVISION = 5;
    public const uint WPD_RESOURCE_DEFAULT = 0;
    public const uint WPD_STORAGE_FREE_SPACE_IN_BYTES = 5;

    private PortableDeviceManager deviceManager;

    class WPDDevice
    {
      public string DeviceID;
      public string DeviceName;
      public PortableDeviceClass DeviceClass;

      public override string ToString()
      {
        return string.Format("WPDデバイス名:{0}\r\n", DeviceName);
      }
    }

    public enum ObjectKind { FOLDER, FILE};

    public class PortableDeviceObject
    {
      public string Id { get; set; }
      public string Name { get; set; }
      public ObjectKind kind { get; set; }
    }

    public FormMain()
    {
      InitializeComponent();
    }

    private void FormMain_Load(object sender, EventArgs e)
    {
      init();
    }

    private void init()
    {
      deviceManager = new PortableDeviceManager();

      deviceManager.RefreshDeviceList();
      uint count = 0;
      deviceManager.GetDevices(null, ref count);

      string[] devicesIDs = new string[count];
      WPDDevice[] wpdDevice = new WPDDevice[count];

      deviceManager.GetDevices(devicesIDs, ref count);
      for (int i = 0; i < count; i++) {
        wpdDevice[i] = new WPDDevice();
        wpdDevice[i].DeviceID = devicesIDs[i];
      }

      IPortableDeviceValues clientInfo = (IPortableDeviceValues)new PortableDeviceTypesLib.PortableDeviceValuesClass();

      for (int i = 0; i < count; i++) {
        wpdDevice[i].DeviceClass = new PortableDeviceClass();
        wpdDevice[i].DeviceClass.Open(wpdDevice[i].DeviceID, clientInfo);

        IPortableDeviceContent content;
        wpdDevice[i].DeviceClass.Content(out content);
        
        IPortableDeviceProperties properties;
        content.Properties(out properties);

        IPortableDeviceValues propertyValues;
        properties.GetValues("DEVICE", null, out propertyValues);

        //wpdDevice[i].DeviceClass.Close();

        string name;
        _tagpropertykey property = new _tagpropertykey();
        property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
        property.pid = 4;
        try {
          propertyValues.GetStringValue(property, out name);
          wpdDevice[i].DeviceName = name;
        }
        catch (System.Runtime.InteropServices.COMException) {
          wpdDevice[i].DeviceName = "なし";
        }

        comboBox_device.Items.Add(wpdDevice[i]);
      }
    }

    private void comboBox_device_SelectedIndexChanged(object sender, EventArgs e)
    {
      DeviceChanged();
    }

    private void DeviceChanged()
    {
      WPDDevice device = (WPDDevice)comboBox_device.SelectedItem;

      IPortableDeviceContent content;
      device.DeviceClass.Content(out content);

      IPortableDeviceProperties properties;
      content.Properties(out properties);

      IEnumPortableDeviceObjectIDs objectIDs;
      string FolderID= "DEVICE";
      content.EnumObjects(0, FolderID, null, out objectIDs);

      listView1.Items.Clear();

      string objectID;
      uint fetched = 0;

      while (true) {
        objectIDs.Next(1, out objectID, ref fetched);
        if (fetched <= 0) break;

        PortableDeviceObject currentObject = WrapObject(properties, objectID);

        ListViewItem li = listView1.Items.Add(currentObject.Name);
        switch (currentObject.kind) {
          case ObjectKind.FILE:
            li.SubItems.Add("ファイル");
            break;
          case ObjectKind.FOLDER:
            li.SubItems.Add("フォルダ");
            break;
        }
        li.SubItems.Add(currentObject.Id);
      }
    }


    private void listView1_DoubleClick(object sender, EventArgs e)
    {
      string FolderID = listView1.Items[listView1.SelectedItems[0].Index].SubItems[2].Text;
      WPDDevice device = (WPDDevice)comboBox_device.SelectedItem;

      IPortableDeviceContent content;
      device.DeviceClass.Content(out content);

      IPortableDeviceProperties properties;
      content.Properties(out properties);

      IEnumPortableDeviceObjectIDs objectIDs;
      content.EnumObjects(0, FolderID, null, out objectIDs);

      listView1.Items.Clear();

      string objectID;
      uint fetched = 0;

      while (true) {
        objectIDs.Next(1, out objectID, ref fetched);
        if (fetched <= 0) break;

        PortableDeviceObject currentObject = WrapObject(properties, objectID);

        ListViewItem li = listView1.Items.Add(currentObject.Name);
        switch (currentObject.kind) {
          case ObjectKind.FILE:
            li.SubItems.Add("ファイル");
            break;
          case ObjectKind.FOLDER:
            li.SubItems.Add("フォルダ");
            break;
        }
        li.SubItems.Add(currentObject.Id);
      }
    }

    public static PortableDeviceObject WrapObject(IPortableDeviceProperties properties, string objectID)
    {
      IPortableDeviceKeyCollection keys;
      properties.GetSupportedProperties(objectID, out keys);

      IPortableDeviceValues values;
      properties.GetValues(objectID, keys, out values);

      // Get the name of the object
      string name;
      _tagpropertykey property = new _tagpropertykey();
      property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
      property.pid = WPD_OBJECT_NAME;

      try {
        values.GetStringValue(property, out name);
      }
      catch (System.Runtime.InteropServices.COMException exc) {
        name = "(non name)";
      }

      // Get the original name of the object
      string OriginalName;
      property = new _tagpropertykey();
      property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
      property.pid = WPD_OBJECT_ORIGINAL_FILE_NAME;
      try {
        values.GetStringValue(property, out OriginalName);
      }
      catch (Exception e) {
        OriginalName = "";
      }

      // Get the type of the object
      Guid contentType;
      property = new _tagpropertykey();
      property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
      property.pid = WPD_OBJECT_CONTENT_TYPE;
      try {
        values.GetGuidValue(property, out contentType);
      }
      catch (System.Runtime.InteropServices.COMException exc) {
        PortableDeviceObject obj = new PortableDeviceObject();
        obj.Id = null;
        obj.Name = name;
        obj.kind = ObjectKind.FOLDER;
        return obj;
      }

      Guid folderType = new Guid(0x27E2E392, 0xA111, 0x48E0, 0xAB, 0x0C, 0xE1, 0x77, 0x05, 0xA0, 0x5F, 0x85);
      Guid functionalType = new Guid(0x99ED0160, 0x17FF, 0x4C44, 0x9D, 0x98, 0x1D, 0x7A, 0x6F, 0x94, 0x19, 0x21);

      if (contentType == folderType || contentType == functionalType) {
        PortableDeviceObject fobj = new PortableDeviceObject();
        fobj.Id = objectID;
        fobj.Name = name;
        fobj.kind = ObjectKind.FOLDER;
        return fobj;
      }

      if (OriginalName.CompareTo("") != 0) {
        name = OriginalName;
      }

      PortableDeviceObject robj = new PortableDeviceObject();
      robj.Id = objectID;
      robj.Name = name;
      robj.kind = ObjectKind.FILE;
      return robj;
    }
  }
}

解説

デバイスの接続部

デバイスの接続部のコード init メソッド部分についてはこちらの記事を参照してください。
違いは接続した後、ファイルやフォルダを取得するためデバイスをCloseしない部分が異なります。また、デバイスID、デバイス名、PortableDeviceClass をまとめて保存できるようWPDDeviceクラスを用意してメンバ変数に値を格納する動作にしています。接続されているWPDデバイスはコンボボックスに追加します。
コンボボックスへの値の表示はWPDDeviceクラスにToStringメソッドを実装して実現しています。詳しい動作はこちらの記事を参照してください。

コンボボックスが変更された場合

コンボボックスの選択内容が変更された場合はDeviceChanged メソッドを呼び出します。
DeviceChanged メソッドの前半部分はPortableDeviceClass のContentメソッドを呼び出し、IPortableDeviceContent コンテンツを取得し、その後IPortableDeviceContent オブジェクトのPropertiesメソッドを呼び出しIPortableDeviceProperties プロパティを取得します。
フォルダの一覧はIPortableDeviceContent オブジェクトのEnumObjectsにより取得できます。EnumObjectsの第一引数は使われないため0を、第二引数には取得するフォルダのパスを与えます。コンボボックスが選択された直後のため、ルートディレクトリのファイル、フォルダの一覧を取得します。ルートディレクトリを取得する場合は"DEVICE"の文字列を与えます。第三引数は使われないため、nullを与えます。第四引数に取得したオブジェクトの結果が代入されます。IEnumPortableDeviceObjectIDs 型の変数を与えます。

  private void DeviceChanged()
  {
    WPDDevice device = (WPDDevice)comboBox_device.SelectedItem;

    IPortableDeviceContent content;
    device.DeviceClass.Content(out content);

    IPortableDeviceProperties properties;
    content.Properties(out properties);

    IEnumPortableDeviceObjectIDs objectIDs;
    string FolderID = "DEVICE";
    content.EnumObjects(0, FolderID, null, out objectIDs);

EnumObjects メソッドにより取得した、IEnumPortableDeviceObjectIDs の各値を読み出します。IEnumPortableDeviceObjectIDs オブジェクトのNext メソッドを呼び出しオブジェクトの個々の要素にアクセスします。Nextメソッドの第一引数にはリクエストするオブジェクト数を与えます。今回は1つずつ読み出しますので1を与えます。第二引数には取得したオブジェクトのIDが戻ります。第三引数には取得できたオブジェクトの数が戻ります。
Nextメソッドにより取得したオブジェクトのIDからファイル、フォルダの名前や種類を取得します。取得部分はWrapObject メソッドで実行します。取得した情報はPortableDeviceObjectクラスのメンバ変数に格納しています。PortableDeviceObjectクラスのメンバ変数を参照してリストビューに項目(ファイル/フォルダ名、ファイル/フォルダの種別、オブジェクトID)を追加しています。
通常は Next メソッドの戻り値を確認することで要素がこれ以上存在しないかを確認しますが、今回利用するC#のタイプライブラリでは、Nextメソッドの戻り値が無いため、fetchedの値が0以下であった場合にこれ以上要素が無いと判断してループを抜けます。

    listView1.Items.Clear();

    string objectID;
    uint fetched = 0;

    while (true) {
      objectIDs.Next(1, out objectID, ref fetched);
      if (fetched <= 0) break;

      PortableDeviceObject currentObject = WrapObject(properties, objectID);

      ListViewItem li = listView1.Items.Add(currentObject.Name);
      switch (currentObject.kind) {
        case ObjectKind.FILE:
          li.SubItems.Add("ファイル");
          break;
        case ObjectKind.FOLDER:
          li.SubItems.Add("フォルダ");
          break;
      }
      li.SubItems.Add(currentObject.Id);
    }
  }

リストビューがダブルクリックされた場合

リストビューがダブルクリックされた場合は、そのときに選択していた要素の子要素を取得してリストビューに表示します。具体的にはフォルダ内のファイルを表示する動作です。
前半部分は先のコンボボックスの場合と同じ処理です。IPortableDeviceContent, IPortableDeviceProperties を取得し、EnumObjectsで要素の一覧を取得します。EnumObjectsに与えるオブジェクトIDは選択されたリストビューの要素の値を利用します。EnumObjectsでダブルクリック時に選択されている要素の子オブジェクトが取得されます。

  private void listView1_DoubleClick(object sender, EventArgs e)
  {
    string FolderID = listView1.Items[listView1.SelectedItems[0].Index].SubItems[2].Text;
    WPDDevice device = (WPDDevice)comboBox_device.SelectedItem;

    IPortableDeviceContent content;
    device.DeviceClass.Content(out content);

    IPortableDeviceProperties properties;
    content.Properties(out properties);

    IEnumPortableDeviceObjectIDs objectIDs;
    content.EnumObjects(0, FolderID, null, out objectIDs);

後半部分はコンボボックスの場合とほぼ同じ処理です。IEnumPortableDeviceObjectIDs オブジェクトのNext メソッドを呼び出しオブジェクトを取得してリストビューに表示します。

    listView1.Items.Clear();

    string objectID;
    uint fetched = 0;

    while (true) {
      objectIDs.Next(1, out objectID, ref fetched);
      if (fetched <= 0) break;

      PortableDeviceObject currentObject = WrapObject(properties, objectID);

      ListViewItem li = listView1.Items.Add(currentObject.Name);
      switch (currentObject.kind) {
        case ObjectKind.FILE:
          li.SubItems.Add("ファイル");
          break;
        case ObjectKind.FOLDER:
          li.SubItems.Add("フォルダ");
          break;
      }
      li.SubItems.Add(currentObject.Id);
    }
  }

オブジェクトのIDからファイル、フォルダの名前や種類を取得する

IEnumPortableDeviceObjectIDs オブジェクトのNext メソッドで取得したオブジェクトのIDからオブジェクト名や種別を取得するコードが下記になります。
IPortableDeviceProperties オブジェクトのGetSupportedPropertieメソッドを呼び出し IPortableDeviceKeyCollection を取得します。続いて、IPortableDeviceProperties オブジェクトのGetValues メソッドを呼び出しIPortableDeviceValues オブジェクトを取得します。GetValues メソッドの第一引数に取得したいオブジェクトのID、第二引数にIPortableDeviceKeyCollection を与えます。
オブジェクトの情報の取得には _tgpropertykey オブジェクトを利用します。_tagpropertykey オブジェクトを作成し、fmtidメンバにGUIDを設定します。GUIDの値は 0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C を利用します。pidには取得する情報に応じた値を設定します。オブジェクトの名前を取得するため、WPD_OBJECT_NAME を与えます。
IPortableDeviceValues オブジェクトの GetStringValue メソッドを呼び出し値を取得します。第一引にIPortableDeviceProperties オブジェクトを与え、第二引数に取得した値を格納するstring変数を与えます。
同様の処理を繰り返しオブジェクトのオリジナル名、種別を取得します。

public static PortableDeviceObject WrapObject(IPortableDeviceProperties properties, string objectID)
  {
    IPortableDeviceKeyCollection keys;
    properties.GetSupportedProperties(objectID, out keys);

    IPortableDeviceValues values;
    properties.GetValues(objectID, keys, out values);

    // Get the name of the object
    string name;
    _tagpropertykey property = new _tagpropertykey();
    property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
    property.pid = WPD_OBJECT_NAME;

    try {
      values.GetStringValue(property, out name);
    }
    catch (System.Runtime.InteropServices.COMException exc) {
      name = "(non name)";
    }

    // Get the original name of the object
    string OriginalName;
    property = new _tagpropertykey();
    property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
    property.pid = WPD_OBJECT_ORIGINAL_FILE_NAME;
    try {
      values.GetStringValue(property_n, out OriginalName);
    }
    catch (Exception e) {
      OriginalName = "";
    }

    // Get the type of the object
    Guid contentType;
    property = new _tagpropertykey();
    property.fmtid = new Guid(0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C);
    property.pid = WPD_OBJECT_CONTENT_TYPE;
    try {
      values.GetGuidValue(property, out contentType);
    }
    catch (System.Runtime.InteropServices.COMException exc) {
      PortableDeviceObject obj = new PortableDeviceObject();
      obj.Id = null;
      obj.Name = name;
      obj.kind = ObjectKind.FOLDER;
      return obj;
    }

取得した値を判定しフォルダかファイル化を判別します。また、PortableDeviceObject クラスのメンバ変数に代入してメソッドの戻り値とします。

    Guid folderType = new Guid(0x27E2E392, 0xA111, 0x48E0, 0xAB, 0x0C, 0xE1, 0x77, 0x05, 0xA0, 0x5F, 0x85);
    Guid functionalType = new Guid(0x99ED0160, 0x17FF, 0x4C44, 0x9D, 0x98, 0x1D, 0x7A, 0x6F, 0x94, 0x19, 0x21);

    if (contentType == folderType || contentType == functionalType) {
      PortableDeviceObject fobj = new PortableDeviceObject();
      fobj.Id = objectID;
      fobj.Name = name;
      fobj.kind = ObjectKind.FOLDER;
      return fobj;
    }

    if (OriginalName.CompareTo("") != 0) {
      name = OriginalName;
    }

    PortableDeviceObject robj = new PortableDeviceObject();
    robj.Id = objectID;
    robj.Name = name;
    robj.kind = ObjectKind.FILE;
    return robj;
  }

実行結果

プロジェクトを実行します。下図のウィンドウが表示されます。


コンボボックスを開くと接続されているWPDデバイスが表示されます。接続するWPDデバイスを選択します。


コンボボックスで選択をすると、選択したWPDデバイスのルートディレクトリのファイル、フォルダ一覧が表示されます。このデバイスでは「内部ストレージ」というフォルダが一つあることがわかります。


[内部ストレージ]の項目をダブルクリックします。内部ストレージフォルダ内のファイル、フォルダの一覧が表示されます。


[Pictures]の項目をダブルクリックします。下図の画面が表示されます。


[Screenshots]の項目をダブルクリックします。下図の画面が表示されます。スクリーンショットの画像ファイルが保存されており、一覧が表示できます。

参考

オブジェクトの値を取得するためのGUIDとPIDの組み合わせは下記となります。

名称	GUID	PID	取得する値
WPD_OBJECT_ID	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	2	オブジェクトのID
WPD_OBJECT_PARENT_ID	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	3	親オブジェクトのID
WPD_OBJECT_NAME	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	4	オブジェクトの名称
WPD_OBJECT_CONTENT_TYPE	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	7	オブジェクトのコンテンツタイプ
WPD_OBJECT_SIZE	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	11	オブジェクトのサイズ
WPD_OBJECT_ORIGINAL_FILE_NAME	0xEF6B490D, 0x5CD8, 0x437A, 0xAF, 0xFC, 0xDA, 0x8B, 0x60, 0xEE, 0x4A, 0x3C	12	オブジェクトのオリジナルファイル名
WPD_RESOURCE_DEFAULT	0xE81E79BE, 0x34F0, 0x41BF, 0xB5, 0x3F, 0xF1, 0xA0, 0x6A, 0xE8, 0x78, 0x42	0	オブジェクトのリソース
WPD_DEVICE_FRIENDLY_NAME	0x26D4979A, 0xE643, 0x4626, 0x9E, 0x2B, 0x73, 0x6D, 0xC0, 0xC9, 0x2F, 0xDC	12	オブジェクトのフレンドり名

参考

フォルダ、コンテンツ形式を判断するためのGUIDです。

主要なもの

型	GUID
WPD_CONTENT_TYPE_FOLDER	0x27E2E392, 0xA111, 0x48E0, 0xAB, 0x0C, 0xE1, 0x77, 0x05, 0xA0, 0x5F, 0x85
WPD_CONTENT_TYPE_FUNCTIONAL_OBJECT	0x99ED0160, 0x17FF, 0x4C44, 0x9D, 0x98, 0x1D, 0x7A, 0x6F, 0x94, 0x19, 0x21
WPD_CONTENT_TYPE_GENERIC_FILE	0x0085E0A6, 0x8D34, 0x45D7, 0xBC, 0x5C, 0x44, 0x7E, 0x59, 0xC7, 0x3D, 0x48
WPD_FUNCTIONAL_CATEGORY_STORAGE	0x23F05BBC, 0x15DE, 0x4C2A, 0xA5, 0x5B, 0xA9, 0xAF, 0x5C, 0xE4, 0x12, 0xEF

すべて