Tech Note 23: NSBVFSLib共有ライブラリを使う Oct 21, 2003   © NSB Corporation. All rights reserved.

Contents:

概要
関数インデックス、クイックリファレンス
関数リファレンス
エラーコード

概要:

このライブラリの関数は以下のカテゴリーに分かれています：

Volume, Directory, File, File and Directory, Import/Export

    http://www.palmos.com/dev/tech/docs/

    http://www.palmos.com/dev/tech/tools/

プログラムの　Startup code：

	Sub main()
	    LoadLibrary "NSBVFSLib", "VFS"
	End Sub

また、NSBVFSLibライブラリを使うには、 NSBVFSLib.INFというファイルが、 "nsbasic\lib" というパスにある必要があり、また、実行するデバイスに NSBVFSLib.prcが ダウンロード(インストール)されている必要があります。

関数インデックス、クイックリファレンス:

NSBVFSLib関数リファレンス:

Internal Information

Version

version = VFS.Version()

version as Integer

例

Dim version as Integer 
version = VFS.Version()

GetLastError

error = VFS.GetLastError()

error as Integer.

例

Dim err as Integer 
err = VFS.GetLastError()

Init

result = VFS.Init()

result as Integer.

例

Dim err as Integer 
err = VFS.Init()

ボリューム関数

BeginVolumeEnumerate

VFS.BeginVolumeEnumerate()

例

VFS.BeginVolumeEnumerate()

GetNextVolume

volume = VFS.GetNextVolume()

volume as Integer.

例

Global volRef(4) as Integer

Global numVol as Integer

Dim err as Integer

Dim i as Integer

list.clear

VFS.BeginVolumeEnumerate()

numVol = 0

Do

i = VFS.GetNextVolume()

err = VFS.GetLastError()

If err = 0 Then

    numVol = numVol + 1

    volRef(numVol) = i

Else

    Exit Do

EndIf

Loop

SetCurVolume

VFS.SetCurVolume(volume)

volume as Integer.

例

VFS.SetCurVolume(volRef(0))

GetVolumeLabel

label = VFS.GetVolumeLabel()

label as String.

例 

Dim label as String 
label = VFS.GetVolumeLabel()

SetVolumeLabel

VFS.SetVolumeLabel(label)

label as string.

例

Dim label as String 
label = "my volume label" 
VFS.SetVolumeLabel(label)

IsVolumeReadOnly

result = VFS.IsVolumeReadOnly()

result as Integer.

例

Dim volumeReadOnly as Integer
Dim VROStr as String
volumeReadOnly = VFS.IsVolumeReadOnly()
VROStr = "Read/Write"
if volumeReadOnly = 1 then VROStr = "Read"

IsVolumeHidden

result = VFS.IsVolumeHidden()

result as Integer.

例

Dim volumeHidden as Integer
Dim HStr as String
volumeHidden = VFS.IsVolumeHidden()
HStr = "Visible"
if volumeHidden = 1 then HStr = "Hidden"

VolumeUsedSize

size = VFS.VolumeUsedSize()

size as Integer.

例

Dim volUsedSize as Integer 
volUsedSize =VFS.VolumeUsedSize()

VolumeTotalSize

size = VFS.VolumeTotalSize()

size as Integer.

例

Dim volTotalSize as Integer  
volTotalSize= VFS.VolumeTotalSize()

VolumeFormat

VFS.VolumeFormat()

VFS.VolumeFormat()

GetVolumeMediaType

mediaType = VFS.GetVolumeMediaType()

mediaType as Integer.
 

Possible MEDIATYPEs
0	Matches all media types when looking up a default directory
1	Memory stick
2	Compact Flash
3	Secure Digital
4	MultiMedia Card
5	SmartMedia
6	A RAM disk based media
7	Host file system emulated by the Palm OS® Emulator
8	Host file system emulated by the Mac Simulator

例

Dim t(9) as String

Dim err as Integer

Dim m as Integer

t(1) = "Wild"

t(2) = "Memory stick"

t(3) = "Compact Flash"

t(4) = "Secure Digital"

t(5) = "MultiMedia Card"

t(6) = "SmartMedia"

t(7) = "A RAM disk based media"

t(8) = "HFS POSE"

t(9) = "HFS Mac Simulator"

m = VFS.GetVolumeMediaType()

fld.text = t(m+1)

ディレクトリ関数

DirCreate

VFS.DirCreate(dirName)

dirName as string

例

Dim path as Strin 
path = "/palm/My directory/" 
VFS.DirCreate(path)

BeginDirEntryEnumerate

VFS.BeginDirEntryEnumerate(directory)

directory as String.

例

Dim path as String 
path = "/palm/My directory/" 
VFS.BeginDirEntryEnumerate(path)

EndDirEntryEnumerate

VFS.EndDirEntryEnumerate()

VFS.EndDirEntryEnumerate()

DirEntryEnumerate

FileOrDirName = VFS.DirEntryEnumerate()

FileOrDirName as String.

例

Dim dir as String
Dim err as Integer
Dim name as String
dir = "/palm/My directory/"
VFS.BeginDirEntryEnumerate(dir)
err = VFS.GetLastError
If err>0 Then GoTo ex
Do
name = VFS.DirEntryEnumerate()
err = VFS.GetLastError()    '10509 end of loop
If err > 0 Then Exit Do
lst.add name
Loop
ex:
VFS.EndDirEntryEnumerate

RegisterDefaultDirectory

VFS.RegisterDefaultDirectory(fileType, indexMediaType, path)

fileType as String, IndexMediaType as Integer, path as String.

indexMediaType see GetVolumeMediaType.

例

Dim fileType as String
Dim indexMediaType as Integer
Dim path as String
fileType = ".txt"
indexMediaType = 3 'Secure Digital
path = "/text/"
VFS.RegisterDefaultDirectory(fileType, indexMediaType, path)

UnregisterDefaultDirectory

VFS.UnregisterDefaultDirectory(string fileType, integer indexMediaType)

fileType  as String, indexMediaType as Integer.

例

Dim fileType as String
Dim indexMediaType as Integer
fileType = ".txt"
indexMediaType = 3 'Secure Digital
VFS.UnregisterDefaultDirectory(fileType, indexMediaType)

GetDefaultDirectory

path = VFS.GetDefaultDirectory(fileType)

fileType as String.

戻り値

path as String

例

Dim fileType as String
Dim path as String
fileType = ".txt"
path = VFS.GetDefaultDirectory(fileType)

ファイル関数

IsEOF

eof = VFS.IsEof(fileRef)

fileRef as Integer. 戻り値

eof as Integer.

例

Dim sh as Short
Dim eof as Integer
Dim fileRef as Integer
...' open file
Do
sh = VFS.Read16(fileRef)
eof = VFS.IsEof(fileRef)
If eof = 1 Then Exit Do
Loop
...' close file

FileCreate

VFS.FileCreate(path)

path as String.

例

Dim pathName as String 
pathName = "/palm/My directory/Sample.txt" 
VFS.FileCreate(pathName)

Read16

res = VFS.Read16(fileRef)

fileRef as Integer. 戻り値

res as Short.

例

Dim data16 as Short 
data16 = VFS.Read16(fileRef)

Read32

res = VFS.Read32(fileRef)

fileRef as Integer. 戻り値

res as Integer.

例 

Dim data32 as Integer 
data32 = VFS.Read32(fileRef)

Read64

res = VFS.Read64(fileRef)

fileRef as Integer. 戻り値

res as double.

例 

Dim data64 as Double 
data64 = VFS.Read64(fileRef)

ReadString

res = VFS.ReadString(fileRef)

fileRef as Integer. 戻り値

res as String.

例

Dim dataStr as String 
dataStr = VFS.ReadString(fileRef)

Write16

fileRef as Integer, data as Short.

例

Dim data16 as Short 
VFS.Write16(fileRef, data16)

Write32

VFS.Write32(fileRef, data)

fileRef as Integer, data as Integer.

例

Dim data32 as Integer 
VFS.Write32(fileRef, data32)

Write64

VFS.Write64(fileRef, data)

fileRef as Integer, data as Double.

例

Dim data64 as Double 
VFS.Write64(fileRef, data64)

WriteString

VFS.WriteString(Integer fileRef, string str)

fileRef as Integer, str as String.

例

Dim dataStr as String 
VFS.WriteString(fileRef, dataStr)

FileTell

pos = VFS.FileTell(fileRef)

fileRef as Integer. 戻り値

pos as Integer.

例

Dim pos as Integer 
pos = VFS.FileTell(fileRef)

FileSize

size = VFS.FileSize(fileRef)

fileRef as Integer. 戻り値

size as Integer.

例

Dim size as Integer 
size = VFS.FileSize(fileRef)

FileResize

VFS.FileResize(fileRef, newSize)

fileRef as Integer, newSize as Integer.

例

Dim newSize as Integer 
VFS.FileResize(fileRef, newSize)

FileSeekBegin

VFS.FileSeekBegin(fileRef, offset)

fileRef as Integer, offset as Integer.

例

Dim offset as Integer 
offset = 10 
VFS.FileSeekBegin(fileRef, offset)

FileSeekCurrent

VFS.FileSeekCurrent(fileRef, offset)

fileRef as Integer, offset as Integer.

例

Dim offset as Integer 
offset = 10 
VFS.FileSeekCurrent(fileRef, offset)

FileSeekEnd

VFS.FileSeekEnd(fileRef, offset)

fileRef as Integer, offset as Integer.

例

Dim offset as Integer 
offset = 10 
VFS.FileSeekEnd(fileRef, offset)

File and directory functions

Delete

VFS.Delete(path)

path as String.

例

Dim path as String 
path = "/palm/My directory/Sample.dat" 
VFS.Delete(path)

Close

VFS.Close(fileRef)

fileRef as Integer.

例

VFS.Close(fileRef)

Rename

VFS.Rename(pathName, newName)

pathName as String, newName as String.

例

Dim pathName as String
Dim newName as String
pathName = "/palm/My directory/Sample.dat"
newName = "Test.dat"
VFS.Rename(pathName, newName)

SetDateCreated

VFS.SetDateCreated(fileRef,date)

fileRef as Integer, date as Integer.

例

Dim dateCreated as Integer
dateCreated = 123456789        ' seconds
VFS.SetDateCreated(fileRef,dateCreated)

SetDateModified

VFS.SetDateModified(fileRef, date)

fileRef as Integer, date as Integer.

例

Dim dateModified as Integer
dateModified = 123456789        ' seconds
VFS.SetDateModified(fileRef,dateModified)

SetDateAccessed

VFS.SetDateAccessed(fileRef,date)

fileRef as Integer, date as Integer.

例

Dim dateAccessed as Integer
dateAccessed = 123456789        ' seconds
VFS.SetDateAccessed(fileRef,dateAccessed)

GetDateCreated

date = VFS.GetDateCreated(fileRef)

fileRef as Integer. 戻り値

date as Integer.

例

Dim dateCreated as Integer 
dateCreated = VFS.GetDateCreated(fileRef)

GetDateModified

date = VFS.GetDateModified(fileRef)

fileRef as Integer. 戻り値

date as Integer.

例

Dim dateModified as Integer 
dateModified = VFS.GetDateModified(fileRef)

GetDateAccessed

date = VFS.GetDateAccessed(fileRef)

fileRef as Integer. 戻り値

date as Integer.

例

Dim dateAccessed as Integer 
dateAccessed = VFS.GetDateAccessed(fileRef)

SetAttributes

VFS.SetAttributes(fileRef, attributes)

fileRef as Integer, attributes as Integer.
 

属性一覧
1	読み込み専用ファイル／ディレクトリ
2	隠れたファイル／ディレクトリ
4	システムファイル／ディレクトリ
8	ボリュームレーベル
16	ディレクトリ
32	アーカイブ ファイル／ディレクトリ
64	別のファイル／ディレクトリにリンク

注：Volume label(8)とDirectory(16)属性を変更するのに、SetAttributesサブルーチンは使用できません。

例

VFS.SetAttributes(fileRef,2)' 2 - hidden

ResetAttributes

VFS.ResetAttributes(fileRef, attributes)

fileRef as Integer, attributes as Integer.

注：Volume label(8)とDirectory(16)属性を変更するのに、ResetAttributesサブルーチンは使用できません。

例

VFS.ResetAttributes(fileRef,2)' 2 - hidden

GetAttributes

coinside = VFS.GetAttributes(fileRef, checkAttributes)

fileRef as Integer, checkAttributes as Integer. 戻り値

coinside as Integer.

例

Dim coinside as Integer 
coinside = VFS.GetAttributes(fileRef, 2)' is it hidden?

Open

fileRef = VFS.Open(pathName, openMode)

pathName as String, openMode as Integer. 戻り値

fileRef as Integer.
 

OPENMODE 定数
2	読み取りアクセスで開く
3	読み取りアクセスで開いてロック
7	読み取り／書き込みアクセスで開いてロック
15	読み取り／書き込みアクセスで開いてロック、ファイルが存在しない場合は作成

例

Dim pathName as String
Dim fileRef as Integer
pathName ="/palm/My directory/Sample.dat"
fileRef = VFS.Open(pathName,7)

インポート／エキスポート

Import

dbName = VFS.Import(pathName)

pathName as String is the full path for .pdb or .prc. 戻り値

dbName as String.

例

Dim pathName as String
Dim dbName as String
pathName="/palm/My directory/Puzzle.prc"
dbName = VFS.Import(pathName)

Export

VFS.Export(dbName, pathName)

dbName as String is the database name, pathName as String is the full path for .pdb or .prc.

例

Dim pathName as String
Dim dbName as String
dbName="15-Puzzle"
pathName="/palm/My directory/Puzzle.prc"
VFS.Export(dbName, pathName)

ImportDialog

dbName = VFS.ImportDialog(pathName, dialogTitle, actionStr)

pathName as String is the full path for .pdb or .prc., dialogTitle as String is the title of dialog, actionStr as String is the dialog message.

戻り値

dbName as String.

例

Dim pathName as String
Dim dbName as String
Dim dialogTitle as String
Dim actionStr as String
pathName="/palm/My directory/Puzzle.prc"
dialogTitle="Import file"
actionStr="Importing Puzzle.prc"
dbName = VFS.ImportDialog(pathName, dialogTitle, actionStr)

ExportDialog

VFS.ExportDialog(dbName, pathName , dialogTitle, actionStr)

dbName as String is the database name, pathName as String is the full path for .pdb or .prc, dialogTitle as String is the title of dialog, actionStr as String is the dialog message.

例

Dim pathName as String
Dim dbName as String
Dim dialogTitle as String
Dim actionStr as String
dbName="15-Puzzle"
pathName="/palm/My directory/Puzzle.prc"
dialogTitle="Export file"
actionStr="Exporting "
actionStr= actionStr + dbName
VFS.ExportDialog(dbName,pathName , dialogTitle, actionStr)

カード情報

GetDeviceUniqueIDStr

DeviceUniqueIDStr = VFS.GetDeviceUniqueIDStr

戻り値

DeviceUniqueIDStr as String.

例

Dim GetDeviceUniqueIDStr as String
GetDeviceUniqueIDStr = VFS.GetDeviceUniqueIDStr

エラーコード