このサンプルでは、System.Management.Automation.Provider.DriveCmdletProvider.NewDrive* および System.Management.Automation.Provider.DriveCmdletProvider.RemoveDrive* メソッドを上書きして、New-PSDrive
および Remove-PSDrive
コマンドレットの呼び出しをサポートする方法を示します。 このサンプルのプロバイダー クラスは、System.Management.Automation.Provider.DriveCmdletProvider クラスから派生しています。
対象
重要
プロバイダー クラスは、ほとんどの場合、次のいずれかのクラスから派生し、場合によっては他のプロバイダー インターフェイスを実装します。
- System.Management.Automation.Provider.ItemCmdletProvider クラスを します。 AccessDBProviderSample03 参照してください。
- System.Management.Automation.Provider.ContainerCmdletProvider クラスを します。 AccessDBProviderSample04 を参照してください。
- system.Management.Automation.Provider.NavigationCmdletProvider クラスを します。 AccessDBProviderSample05 を参照してください。
プロバイダーの機能に基づいて派生するプロバイダー クラスの選択の詳細については、「Windows PowerShell プロバイダーの設計」を参照してください。
このサンプルでは、次の例を示します。
CmdletProvider
属性の宣言。System.Management.Automation.Provider.DriveCmdletProvider クラスからドライブするプロバイダー クラスを定義します。
新しいドライブの作成をサポートするために、System.Management.Automation.Provider.DriveCmdletProvider.NewDrive* メソッドを上書きします。 (このサンプルでは、
New-PSDrive
コマンドレットに動的パラメーターを追加する方法は示していません)。System.Management.Automation.Provider.DriveCmdletProvider.RemoveDrive* メソッドを上書きして、既存のドライブの削除をサポートします。
例
このサンプルでは、System.Management.Automation.Provider.DriveCmdletProvider.NewDrive* および System.Management.Automation.Provider.DriveCmdletProvider.RemoveDrive* メソッドを上書きする方法を示します。 このサンプル プロバイダーの場合、ドライブが作成されると、その接続情報は AccessDBPsDriveInfo
オブジェクトに格納されます。
using System;
using System.IO;
using System.Data;
using System.Data.Odbc;
using System.Management.Automation;
using System.Management.Automation.Provider;
using System.ComponentModel;
namespace Microsoft.Samples.PowerShell.Providers
{
#region AccessDBProvider
/// <summary>
/// A PowerShell Provider which acts upon a access data store.
/// </summary>
/// <remarks>
/// This example only demonstrates the drive overrides
/// </remarks>
[CmdletProvider("AccessDB", ProviderCapabilities.None)]
public class AccessDBProvider : DriveCmdletProvider
{
#region Drive Manipulation
/// <summary>
/// Create a new drive. Create a connection to the database file and set
/// the Connection property in the PSDriveInfo.
/// </summary>
/// <param name="drive">
/// Information describing the drive to add.
/// </param>
/// <returns>The added drive.</returns>
protected override PSDriveInfo NewDrive(PSDriveInfo drive)
{
// check if drive object is null
if (drive == null)
{
WriteError(new ErrorRecord(
new ArgumentNullException("drive"),
"NullDrive",
ErrorCategory.InvalidArgument,
null)
);
return null;
}
// check if drive root is not null or empty
// and if its an existing file
if (String.IsNullOrEmpty(drive.Root) || (File.Exists(drive.Root) == false))
{
WriteError(new ErrorRecord(
new ArgumentException("drive.Root"),
"NoRoot",
ErrorCategory.InvalidArgument,
drive)
);
return null;
}
// create a new drive and create an ODBC connection to the new drive
AccessDBPSDriveInfo accessDBPSDriveInfo = new AccessDBPSDriveInfo(drive);
OdbcConnectionStringBuilder builder = new OdbcConnectionStringBuilder();
builder.Driver = "Microsoft Access Driver (*.mdb)";
builder.Add("DBQ", drive.Root);
OdbcConnection conn = new OdbcConnection(builder.ConnectionString);
conn.Open();
accessDBPSDriveInfo.Connection = conn;
return accessDBPSDriveInfo;
} // NewDrive
/// <summary>
/// Removes a drive from the provider.
/// </summary>
/// <param name="drive">The drive to remove.</param>
/// <returns>The drive removed.</returns>
protected override PSDriveInfo RemoveDrive(PSDriveInfo drive)
{
// check if drive object is null
if (drive == null)
{
WriteError(new ErrorRecord(
new ArgumentNullException("drive"),
"NullDrive",
ErrorCategory.InvalidArgument,
drive)
);
return null;
}
// close ODBC connection to the drive
AccessDBPSDriveInfo accessDBPSDriveInfo = drive as AccessDBPSDriveInfo;
if (accessDBPSDriveInfo == null)
{
return null;
}
accessDBPSDriveInfo.Connection.Close();
return accessDBPSDriveInfo;
} // RemoveDrive
#endregion Drive Manipulation
} // AccessDBProvider
#endregion AccessDBProvider
#region AccessDBPSDriveInfo
/// <summary>
/// Any state associated with the drive should be held here.
/// In this case, it's the connection to the database.
/// </summary>
internal class AccessDBPSDriveInfo : PSDriveInfo
{
private OdbcConnection connection;
/// <summary>
/// ODBC connection information.
/// </summary>
public OdbcConnection Connection
{
get { return connection; }
set { connection = value; }
}
/// <summary>
/// Constructor that takes one argument
/// </summary>
/// <param name="driveInfo">Drive provided by this provider</param>
public AccessDBPSDriveInfo(PSDriveInfo driveInfo)
: base(driveInfo)
{ }
} // class AccessDBPSDriveInfo
#endregion AccessDBPSDriveInfo
}
こちらもご覧ください
System.Management.Automation.Provider.ItemCmdletProvider
System.Management.Automation.Provider.ContainerCmdletProvider
System.Management.Automation.Provider.NavigationCmdletProvider
PowerShell