Join 関数 (Visual Basic)

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

配列に含まれる多数の部分文字列を結合して作成される文字列を返します。

Function Join(
   ByVal SourceArray() As { Object | String },
   Optional ByVal Delimiter As String = " "
) As String

パラメータ

SourceArray
必ず指定します。結合する部分文字列を含む 1 次元配列を指定します。
Delimiter
省略可能です。戻り値となる文字列を部分文字列に区切るのに使用する文字列を指定します。省略すると、スペース (" ") が使用されます。Delimiter が長さ 0 の文字列 ("") かまたは Nothing である場合は、リスト内のすべての項目が区切り文字なしで連結されます。

例外

例外の種類	エラー番号	条件
ArgumentException	5	SourceArray が 1 次元ではありません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要に置き換えることを検討してください。

解説

Join 関数と Split 関数の間には類似点があります。Join 関数は文字列の配列を受け取り、それらをデリミタ文字列を使って結合し、単一の文字列を返します。Split 関数は文字列を受け取って区切り文字の位置で分割し、文字列の配列を返します。ただし、Join がデリミタ文字列を使って文字列を結合できるのに対し、Split が文字列を分割する際には、デリミタ文字 (1 文字) しか使用できないという重要な違いがあります。

使用例

Join 関数を使用して、複数の文字列からリストを作成する例は次のようになります。

Dim TestItem() As String = {"Pickle", "Pineapple", "Papaya"}
' Returns "Pickle, Pineapple, Papaya"
Dim TestShoppingList As String = Join(TestItem, ", ")