Stringクラス

文字列を扱うクラスです。

クラスの機能

メンバ・プロパティ

Chars

Chars As *Byte

Stringが保持している文字列へのポインタです。これを通じて内容の読み取り・書き込みを行うことができます。

Length

Length As Long

Stringが保持している文字列の長さを表しています。基本的に書き換えないでください。

メソッド

コンストラクタ

Stringインスタンスを初期化します。

Sub String()

デフォルトコンストラクタ）空文字列を作ります。

Sub String(ByRef initStr As String)

（未実装）コピーコンストラクタです。initStrの内容で初期化します。

注意: 現在実装されておらず、これを使用しようとすると変換演算子により*Byte引数のコンストラクタが呼ばれます。文字列中にヌル文字を含むStringインスタンスを引数にする際には注意が必要です。

Sub String(ByVal initStr As *Byte)

initStrの内容で初期化します。initStrはヌル終端の文字列を指定します。

Sub String(ByVal initStr As *Byte, length As Long)

initStrの内容で初期化します。文字列の長さをlengthで指定します。

Sub String(length As Long)

String(length, Asc(Ex"\0"))と等価です。

Sub String(length As Long, ByVal initChar As Byte)

initCharをlength文字並べた文字列を作ります。たとえばString(3, Asc("a"))はString("aaa")と同じです。

デストラクタ

Stringインスタンスの破壊時に呼ばれます。

Sub ~String()

文字列のメモリを解放します。

代入

Stringオブジェクトに文字列を割り当てます。

Sub Operator = (ByRef text As String)
Sub Operator = (ByVal text As *Byte)

Assign(text)と同じです。

Assign

Stringオブジェクトに文字列を割り当てます。

Sub Assign(ByRef text As String)
Sub Assign(ByVal text As *Byte)
Sub Assign(ByVal text As *Byte, ByVal length As Long)

textの内容をこのStringインスタンスへコピーします。

Stringを引数に取るものは、text.length文字コピーします。
*Byte単独を引数に取るものは、lstrlen(text)文字コピーします。
lengthを引数に取るものは、length文字分コピーします。

Swap

Sub Swap(ByRef x As String)

ReSize

文字列の大きさを変更します。

Sub ReSize(length As Long)
Sub Resize(length As Long, c As Byte)

1番目の形式はReSize(length, 0)と等価です。文字列の長さをlengthにします。変更後の文字列の長さが変更前より長くなるときには、増えた要素の部分をcで初期化します。

StrPtr

文字列へのポインタを返します。

Function StrPtr() As LPSTR

Charsを返します。

LPSTR変換演算子

文字列へのポインタを得ます。

Function Operator () As LPSTR

StrPtr()呼び出しと等価です。

Insert

文字列を挿入します。

Function Insert(startIndex As Long, ByRef str As String) As Long
Function Insert(startIndex As Long, str As LPSTR) As Long
Function Insert(startIndex As Long, str As LPSTR, length As Long) As Long

startIndex文字目の後にlpszTextの内容を挿入します。挿入される文字列の長さは次のようにしてなります。

1番目の形式ではstr.Length
2番目の形式ではlstrlen(str)
3番目の形式ではlength

Remove

文字列を削除します。

Function Remove(startIndex As Long) As Long
Function Remove(startIndex As Long, count As Long) As Long

1番目の形式では、startIndexで指定した位置から文字列末尾までを削除します。 2番目の形式では、startIndexで指定した位置からcountで指定した数の文字列を削除します。

Replace

文字列の置換を行います。

Sub Replace(oldChar As Byte, newChar As Byte)
Sub Replace(ByRef oldStr As String, ByRef newStr As String)
Sub Replace(oldStr As PCSTR, newStr As PCSTR)
Sub Replace(oldStr As PCSTR, oldLen As Long, newStr As PCSTR, newLen As Long)

1番目の形式では、このStringインスタンス内の文字oldCharをnewCharに置き換えます。 2-4番目の形式では、このStringインスタンス内の文字列oldStrをnewStrに置き換えます。oldStr/newStrの長さは、次のように決まります。

2番目の形式では、oldStr.Length/newStr.Length。
3番目の形式では、lstrlen(oldStr)/newStr(oldStr)。
4番目の形式では、oldLen/newLen。

Operator +

文字列を連結します。

Function Operator+ (str As LPSTR) As String
Function Operator+ (ByRef str As String) As String

このStringインスタンスとstrを連結した新しい文字列を返します。

1番目の形式では、Concat(str, lstrlen(str))と同じです。
2番目の形式では、Concat(str, str.Length)と同じです。

Operator &

文字列を連結します。

Function Operator& (str As LPSTR) As String
Function Operator& (ByRef str As String) As String

このStringインスタンスとstrを連結した新しい文字列を返します。

1番目の形式では、Concat(str, lstrlen(str))と同じです。
2番目の形式では、Concat(str, str.Length)と同じです。

Append

Sub Append(lpszText As LPSTR, textLength As Long)
Sub Append(text As LPSTR)
Sub Append(ByRef str As String)

Concat

この文字列と連結した新しい文字列を作ります。

Function Concat(str As LPSTR, length As Long) As String

str: この文字列と連結する文字列へのポインタを指定します。末尾にヌル文字が存在する必要はありません。
length: strが指す文字列の長さを指定します。
戻り値: 連結した文字列を返します。

このStringインスタンス自身の内容が変更されることはありません。

Operator []

要素を読み取ります。

Function Operator[] (n As Long) As Byte

n文字目の文字を返します。範囲外の場合動作は保障されません。

Operator []=

指定した要素に書き込みます。

Sub Operator[]= (n As Long, c As Byte)

n文字目に文字cを書き込みます。範囲外の場合動作は保障されません。

IndexOf

指定した文字列が最初に見つかった位置を返します。検索は、指定した位置から指定した文字数までとなります。

Function IndexOf(lpszText As LPSTR) As Long
Function IndexOf(lpszText As LPSTR, startIndex As Long) As Long
Function IndexOf(lpszText As LPSTR, startIndex As Long, count As Long) As Long

lpszText: 検索する文字列を指定します。
startIndex: 検索を開始する位置を指定します。省略した場合、文字列の先頭から検索されます。
count: どこまでを検索するか、開始位置からの文字数で指定します。省略した場合、文字列の末尾まで検索されます。
戻り値: 検索した文字列が見つかった場合、その位置が返ります。見つからなかった場合-1が返ります。また、lpszTextに空の文字を指定した場合、startIndexが返ります。

文字列の位置は0から始まります。

LastIndexOf

指定した文字列が最後に見つかった位置を返します。検索は、指定した位置から指定した文字数までとなります。

Function LastIndexOf(lpszText As LPSTR) As Long
Function LastIndexOf(lpszText As LPSTR, startIndex As Long) As Long
Function LastIndexOf(lpszText As LPSTR, startIndex As Long, count As Long) As Long

lpszText: 検索する文字列を指定します。
startIndex: 検索を開始する位置を指定します。省略した場合、文字列の末尾から検索されます。
count: どこまでを検索するか、開始位置からの文字数で指定します。省略した場合、文字列の先頭まで検索されます。
戻り値: 検索した文字列が見つかった場合、その位置が返ります。見つからなかった場合-1が返ります。また、lpszTextに空の文字を指定した場合、startIndexが返ります。

文字列の位置は0から始まります。また、検索は開始位置から文字列の先頭に向かいます。

StartsWith

先頭の文字列が、指定した文字列と一致しているか調べます。

Function StartsWith(lpszText As LPSTR) As BOOL

lpszText: 一致するか調べる文字列を指定します。
戻り値: Charsの先頭がlpszTextと一致している場合、TRUEが返ります。一致していない場合、FALSEが返ります。lpszTextに空の文字列を指定した場合、常にTRUEが返ります。

EndsWith

末尾の文字列が、指定した文字列と一致しているか調べます

Function EndsWith(lpszText As LPSTR) As BOOL

lpszText: 一致するか調べる文字列を指定します。
戻り値: Charsの末尾がlpszTextと一致している場合、TRUEが返ります。一致していない場合、FALSEが返ります。lpszTextに空の文字列を指定した場合、常にTRUEが返ります。

SubString

指定した範囲の文字列を取得します。

Function SubString(startIndex As Long) As String
Function SubString(startIndex As Long, length As Long) As String

startIndex: 開始位置を指定します。
length: 取得する範囲を、文字列の長さでしていします。省略した場合、文字列の最後までになります。
戻り値: Charsの指定した範囲の文字列が、Stringオブジェクトで返ります。