NSDFile メンバ

ファイル、フォルダの操作を行います。

●コンストラクタ

名前 説明
NSDFile NSDFileを初期化します。
ファイルリストの非同期取得(NSDFile.GetFileList)の説明。
フォルダーリストの非同期取得(NSDFile.GetFolderList)の説明。
ファイル、フォルダー数の非同期取得(NSDFile.GetFileFolderCount)の説明。
NSDFile.NSD_Asynchronization_DispControl NSDFile.NSD_Asynchronization_DispControlを初期化します。
NSDFile.NSDFolderSize NSDFile.NSDFolderSizeを初期化します。
NSDFile.NSDCopyFile NSDFile.NSDCopyFileを初期化します。
NSDFile.NSDCopyFolder NSDFile.NSDCopyFolderを初期化します。
NSDFile.NSDDeleteFolder NSDFile.NSDDeleteFolderを初期化します。
NSDFile.NSDTextFile NSDFile.NSDTextFileを初期化します。

　

●メソッドの一覧

名前 引数 戻り値 説明
Dispose なし なし リソースの解放を行います。
IsFolder ( String ) Boolean型 フォルダーが存在するかを返します。
IsFile ( String ) Boolean型 ファイルが存在するかを返します。
ChangeOriginalName ( String ) String型 オリジナルのパス名を返します。
GetFileSize ( String ) Long型 ファイルサイズを返します。
IsUseOkFileName ( String , Boolean ) Boolean型 ファイル名に使用できる文字列かを返します。
IsUseOkPathName ( String , Boolean ) Boolean型 パス名に使用できる文字列かを返します。
DeleteFile ( String ) Boolean型 ファイルを削除します。
RemoveFolder ( String ) Boolean型 フォルダーをゴミ箱に入れます。
GetDriveFreeSpace ( String ) Long型 ドライブの空き容量を返します。
AllocateFile ( String , Long ) Boolean型 指定サイズのファイルを作成します。
IsEqualFile ( String , String ) Boolean型 ファイル内容が一致するかを確認します。

●定数の一覧

名前：NSD_File_Run_Style　(稼働状態。)
名前 内容
NotRunning 稼働していません。
Running 稼働中。

　

名前：NSD_DispControl_ControlKind　(表示用コントロールの動作区分。)
名前 内容
NotSelect 指定なし。
SelectCopyFile コピーファイルで使用。
SelectCopyFolder コピーフォルダーで使用。

　

●NSDFileコンストラクタの説明

構文：Public Sub New()

使用法：Dim Cls_File As New NSDFile

引数：なし。

使用例：

Public Class Form1
    Dim Cls_File As New NSDFile
        :
End Class

●NSDFileメソッドの説明

名前：Dispose
構文：Public Overridable Sub Dispose() Implements IDisposable.Dispose

機能：リソースの解放を行います。

※終了時に必ず呼び出します。

引数：なし。

戻り値：なし。

使用例：

Public Class Form1
    ' NSDFileを初期化。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：IsFolder

構文：Public Function IsFolder( FolderName ) As Boolean

機能：フォルダーが存在するかを返します。

引数：

名前 型 引数渡しの方法 説明
FolderName String 値渡し(ByVal) フォルダーのフルパス名を渡します。

戻り値：Boolean

戻り値の説明：

True：フォルダーが存在します。
False：フォルダーは存在しません。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing( _
                        ByVal sender As Object, _
                        ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                        Handles Me.FormClosing
        Try
            ' NSDFileのリソースを解放します。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        Finally
        End Try
    End Sub

    Private Sub Button1_Click( _
                        ByVal sender As System.Object, _
                        ByVal e As System.EventArgs) _
                        Handles Button1.Click
        Try
            If Cls_File.IsFolder("C:\Data") Then
                MsgBox("フォルダーが存在します。")
            Else
                MsgBox("フォルダーでありません。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：IsFile
構文：Public Function IsFile( FileName ) As Boolean

機能：ファイルが存在するかを返します。

引数：

名前 型 引数渡しの方法 説明
FileName String 値渡し(ByVal) ファイルのフルパス名を渡します。

戻り値：Boolean

戻り値の説明：

True ：ファイルが存在します。
False：ファイルは存在しません。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing( _
                        ByVal sender As Object, _
                        ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                        Handles Me.FormClosing
        Try
            ' NSDFileのリソースを解放します。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        Finally
        End Try
    End Sub

    Private Sub Button1_Click( _
                        ByVal sender As System.Object, _
                        ByVal e As System.EventArgs) _
                        Handles Button1.Click
        Try
            If Cls_File.IsFile("C:\Data\Sample.dat") Then
                MsgBox("ファイルが存在します。")
            Else
                MsgBox("ファイルでありません。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：ChangeOriginalName
構文：Public Function ChangeOriginalName( FullPath ) As String

機能：オリジナルのパス名を返します。

引数：

名前 型 引数渡しの方法 説明
FullPath String 値渡し(ByVal) 存在するファイルまたはフォルダのフルパス名を渡します。

戻り値：String

戻り値の説明：

オリジナルのパス名を返します。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing( _
                        ByVal sender As Object, _
                        ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                        Handles Me.FormClosing
        Try
            ' NSDFileのリソースを解放します。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        Finally
        End Try
    End Sub

    Private Sub Button1_Click( _
                        ByVal sender As System.Object, _
                        ByVal e As System.EventArgs) _
                        Handles Button1.Click
        Try
            Dim Str_Path As String = "C:\DATA\SAMPLE.DAT"
            Dim Str_OPath As String = Cls_File.ChangeOriginalName(Str_Path)
                :
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：GetFileSize
構文：Public Function GetFileSize( FileName ) As Long

機能：ファイルサイズを返します。

引数：

名前 型 引数渡しの方法 説明
FileName String 値渡し(ByVal) ファイルのフルパス名を渡します。

戻り値：Long

戻り値の説明：

-1：ファイルサイズの取得に失敗しました。
0以上はファイルサイズ。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing( _
                        ByVal sender As Object, _
                        ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                        Handles Me.FormClosing
        Try
            ' NSDFileのリソースを解放します。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        Finally
        End Try
    End Sub

    Private Sub Button1_Click( _
                        ByVal sender As System.Object, _
                        ByVal e As System.EventArgs) _
                        Handles Button1.Click
        Try
            Dim Lng_Size As Long = Cls_File.GetFileSize("C:\Data\Sample.DAT")
                :
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：IsUseOkFileName
構文：Public Function IsUseOkFileName( FileName , SearchString ) As Boolean

機能：ファイル名に使用できる文字列かを返します。

引数：

名前 型 引数渡しの方法 説明
FileName String 値渡し(ByVal) ファイルのフルパス名を渡します。
SearchString Boolean 値渡し(ByVal) 検索パターンに使用する文字列かを渡します。
True ：検索パターンは含まれています。
False：検索パターンは含まれていません。

戻り値：Boolean

戻り値の説明：

True ：使用できる文字列です。
False：使用できない文字列が含まれています。

使用例：

Public Class Form1
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs _
                               ) Handles Button1.Click
        Try
            If Cls_File.IsUseOkFileName(Me.TextBox1.Text, False) Then
                MsgBox("ファイル名に使用できます。")
            Else
                MsgBox("ファイル名に使用できない文字が含まれています。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：IsUseOkPathName
構文：Public Function IsUseOkPathName( Path , SearchString ) As Boolean

機能：パス名に使用できる文字列かを返します。

引数：

名前 型 引数渡しの方法 説明
Path String 値渡し(ByVal) パス名を渡します。
SearchString Boolean 値渡し(ByVal) 検索パターンに使用する文字列かを渡します。
True ：検索パターンは含まれています。
False：検索パターンは含まれていません。

戻り値：Boolean

戻り値の説明：

True ：使用できる文字列です。
False：使用できない文字列が含まれています。

使用例：

Public Class Form1
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs _
                               ) Handles Button1.Click
        Try
            If Cls_File.IsUseOkPathName(Me.TextBox1.Text, False) Then
                MsgBox("パス名に使用できます。")
            Else
                MsgBox("パス名に使用できない文字が含まれています。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：DeleteFile
構文：Public Function DeleteFile( FileName ) As Boolean

機能：ファイルを削除します。

引数：

名前 型 引数渡しの方法 説明
FileName String 値渡し(ByVal) 削除するファイルのフルパス名を渡します。

戻り値：Boolean

戻り値の説明：

True ：成功(ファイルが存在しない場合もTrueで返します)。
False：失敗。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing( _
                        ByVal sender As Object, _
                        ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                        Handles Me.FormClosing
        Try
            ' NSDFileのリソースを解放します。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        Finally
        End Try
    End Sub

    Private Sub Button1_Click( _
                        ByVal sender As System.Object, _
                        ByVal e As System.EventArgs) _
                        Handles Button1.Click
        Try
            If Cls_File.DeleteFile("C:\Data\Sample.Dat") Then
                MsgBox("ファイルを削除しました。")
            Else
                MsgBox("ファイルを削除に失敗しました。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：RemoveFolder

構文：Public Function RemoveFolder( FolderPath ) As Boolean

機能：フォルダーをゴミ箱に入れます。

引数：

名前 型 引数渡しの方法 説明
FolderPath String 値渡し(ByVal) ゴミ箱に入れるフォルダのフルパス名を渡します。

戻り値：Boolean

戻り値の説明：

True：成功　False：失敗

使用例：

Public Class Form1
    Dim Cls_File As NSDFile = Nothing

    ' FormClosing。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_DeleteFolder Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    ' フォルダーをゴミ箱に入れます.
    Private Sub Button_Delete_Click( ByVal sender As System.Object, _
                                     ByVal e As System.EventArgs _
                                     ) Handles Button_Delete.Click
        Try
            If MsgBox("フォルダーをゴミ箱に入れます。" & vbCrLf & _
                      "よろしいですか？", MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then
                If Cls_File.RemoveFolder(Me.TextBox_Delete.Text) Then
                    MsgBox("フォルダーをゴミ箱に入れました。")
                Else
                    MsgBox("フォルダーをゴミ箱に入れるのに失敗しました。")
                End If
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：GetDriveFreeSpace
構文：Public Function GetDriveFreeSpace( Path ) As Long

機能：ドライブの空き容量を返します。

引数：

名前 型 引数渡しの方法 説明
Path String 値渡し(ByVal) 空き容量を求めるドライブまたはパス名を渡します。

戻り値：Long

戻り値の説明：

-1=空き容量の取得に失敗しました。
0>=空き容量を返します。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing"
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    ' ドライブの空き容量.
    Private Sub Button_FreeSpace_Click( ByVal sender As System.Object, _
                                        ByVal e As System.EventArgs _
                                        ) Handles Button_FreeSpace.Click
        Try
            Dim Lng_FreeSpace As Long = Cls_File.GetDriveFreeSpace("C:\")
            MsgBox("C:ドライブの空き容量：" & Format(Lng_FreeSpace, "###,##0"))
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：AllocateFile
構文：Public Function AllocateFile( FileName , FileSize ) As Boolean

機能：指定サイズのファイルを作成します。

※ファイルの内容は初期化されません。

引数：

名前 型 引数渡しの方法 説明
FileName String 値渡し(ByVal) 作成するファイルのフルパス名を渡します。
※既にファイルが存在する場合は、失敗します。
FileSize Long 値渡し(ByVal) 作成するファイルサイズを渡します。

戻り値：Boolean

戻り値の説明：

True：成功　False：失敗

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing"
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    ' 指定サイズのファイルを作成。
    Private Sub Button_AllocateFile_Click( ByVal sender As System.Object, _
                                        ByVal e As System.EventArgs _
                                        ) Handles Button_AllocateFile.Click
        Try
            Dim Str_Msg As String = ""
            If Cls_File.IsFolder(Me.TextBox_Create.Text) Then
                MsgBox("フォルダーが存在します。" & vbCrLf & _
                       "作成するファイル名をフルパス名で入力してください。")
            Else
                If Cls_File.IsFile(Me.TextBox_Create.Text) Then
                    MsgBox("既にファイルが存在します。")
                Else
                    Str_Msg = "ファイルを作成します。" & vbCrLf & "よろしいですか？"
                    If MsgBox(Str_Msg, MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then
                        If Cls_File.AllocateFile(Me.TextBox_Create.Text, 10000) Then
                            MsgBox("ファイルを作成しました。")
                        Else
                            MsgBox("ファイルの作成に失敗しました。")
                        End If
                    End If
                End If
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

名前：IsEqualFile
構文：Public Function IsEqualFile( FileName1 , FileName2 ) As Boolean

機能：ファイル内容が一致するかを確認します。

引数：

名前 型 引数渡しの方法 説明
FileName1 String 値渡し(ByVal) 比較するファイル1のフルパス名を渡します。
FileName2 String 値渡し(ByVal) 比較するファイル2のフルパス名を渡します。

戻り値：Boolean

戻り値の説明：

True ：ファイル内容は一致します。
False：ファイル内容は一致しません。

使用例：

Public Class Form1
    ' NSDFileを初期化します。
    Dim Cls_File As New NSDFile

    ' FormClosing。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs _
                                  ) Handles Me.FormClosing
        Try
            ' NSDFileの解放。
            If Not (Cls_File Is Nothing) Then
                Cls_File.Dispose()
                Cls_File = Nothing
            End If
        Catch ex As Exception
        End Try
    End Sub

    ' ファイル内容が一致するかを確認します。
    Private Sub Button_File_Click( ByVal sender As System.Object, _
                                   ByVal e As System.EventArgs _
                                 ) Handles Button_File.Click
        Try
            Dim Str_File1 As String = Me.TextBox1.Text
            Dim Str_File2 As String = Me.TextBox2.Text
            If Cls_File.IsEqualFile(Str_File1, Str_File2) Then
                MsgBox("同じ内容のファイルです。")
            Else
                MsgBox("ファイル内容に相違があります。")
            End If
        Catch ex As Exception
        End Try
    End Sub
End Class

　

Copyright (C) 2010-2012 Nihon System Developer Corp. All Rights Reserved.