docs/ja-jp/build/html/_sources/foxringfuncsdoc.txt

   1 .. index::
   2      single: FoxRing 関数リファレンス; はじめに
   3
   4 ========================
   5 FoxRing 関数リファレンス
   6 ========================
   7
   8 FoxPro 開発者として、 FoxPro 関数を使用したクラスの開発を開始しました。
   9
  10 目標は FoxPro の関数に動作が似ている Ring の関数を可能な限り多数作成することです。
  11
  12 開発者: ホセ・ロサード
  13
  14 .. index::
  15      pair: FoxRing 関数リファレンス; FoxRing 関数
  16
  17 FoxRing 関数
  18 ============
  19
  20 +-----------------------+-----------------------------------------------------------------------------------------------+
  21 | 関数名                | 説明                                                                                          |
  22 +=======================+===============================================================================================+
  23 | frAbs()               | 指定された数値式の絶対値を返します。                                                          |
  24 +-----------------------+-----------------------------------------------------------------------------------------------+
  25 | frAddBs()             | パス表現にバックスラッシュを追加します (必要ならば)。                                         |
  26 +-----------------------+-----------------------------------------------------------------------------------------------+
  27 | frALines()            | 指定された文字列の内容で配列を作成します。                                                    |
  28 +-----------------------+-----------------------------------------------------------------------------------------------+
  29 | frAllTrim()           | 指定された文字列の文頭と文末にある空白文字を全て除去します。                                  |
  30 +-----------------------+-----------------------------------------------------------------------------------------------+
  31 | frAsc()               | 文字式の左端にある文字の ANSI 値を返します。                                                  |
  32 +-----------------------+-----------------------------------------------------------------------------------------------+
  33 | frAt()                | 文字式に出現する別の文字式を検索します (英数大小文字を区別します)。                           |
  34 +-----------------------+-----------------------------------------------------------------------------------------------+
  35 | frAtC()               | 文字式に出現する別の文字式を検索します (英数大小文字を区別しません)。                         |
  36 +-----------------------+-----------------------------------------------------------------------------------------------+
  37 | frBetween()           | 式値が同一型の二式値の間にあるかどうかを確認します。                                          |
  38 +-----------------------+-----------------------------------------------------------------------------------------------+
  39 | frChr()               | ANSI コードを数値で指定して関連づけられている文字列を返します。                               |
  40 +-----------------------+-----------------------------------------------------------------------------------------------+
  41 | frEmpty()             | 式の評価が空であるかどうかを判定します。                                                      |
  42 +-----------------------+-----------------------------------------------------------------------------------------------+
  43 | frFile()              | 指定されたファイルがディスクにあるかどうかを確認します。                                      |
  44 +-----------------------+-----------------------------------------------------------------------------------------------+
  45 | frFileToStr()         | ファイルの内容を文字列として返します。                                                        |
  46 +-----------------------+-----------------------------------------------------------------------------------------------+
  47 | frForceExt()          | ファイルの旧拡張子を新拡張子で置換した文字列を返します。                                      |
  48 +-----------------------+-----------------------------------------------------------------------------------------------+
  49 | frForcePath()         | 古いものの代わりに置換された新しいパス名を使用したファイル名を返します。                      |
  50 +-----------------------+-----------------------------------------------------------------------------------------------+
  51 | frIif()               | 論理式の値により２つの値のうち１つを返します。                                                |
  52 +-----------------------+-----------------------------------------------------------------------------------------------+
  53 | frInList()            | 式が別式にある式集合と一致する式であるかどうか決定します。                                    |
  54 +-----------------------+-----------------------------------------------------------------------------------------------+
  55 | frInt()               | 数値式を評価してから式の整数部分を返します。                                                  |
  56 +-----------------------+-----------------------------------------------------------------------------------------------+
  57 | frJustDrive()         | 絶対パスからドライブ文字を返します。                                                          |
  58 +-----------------------+-----------------------------------------------------------------------------------------------+
  59 | frJustExt()           | 絶対パスからファイル拡張子の文字を返します。                                                  |
  60 +-----------------------+-----------------------------------------------------------------------------------------------+
  61 | frJustFName()         | 絶対パスとファイル名からファイル名の部分を返します。                                          |
  62 +-----------------------+-----------------------------------------------------------------------------------------------+
  63 | frJustPath()          | 絶対パスとファイル名とパスの部分を返します。                                                  |
  64 +-----------------------+-----------------------------------------------------------------------------------------------+
  65 | frJustStem()          | 絶対パスとファイル名からステム名 (拡張子の前のファイル名) を返します。                        |
  66 +-----------------------+-----------------------------------------------------------------------------------------------+
  67 | frLen()               | 式の長さを示すことで、文字式の文字数を決定します。                                            |
  68 +-----------------------+-----------------------------------------------------------------------------------------------+
  69 | frListToString()      | 文字列の配列要素で文字列を作成します。                                                        |
  70 +-----------------------+-----------------------------------------------------------------------------------------------+
  71 | frLTrim()             | 指定された文字式から先頭の空白文字または構文解析文字を全て削除します。                        |
  72 +-----------------------+-----------------------------------------------------------------------------------------------+
  73 | frPadL()              | 左側へ指定された長さの空白文字または文字で桁揃えを行い、式から文字列を返します。              |
  74 +-----------------------+-----------------------------------------------------------------------------------------------+
  75 | frPadR()              | 右側へ指定された長さの空白文字または文字で桁揃えを行い、式から文字列を返します。              |
  76 +-----------------------+-----------------------------------------------------------------------------------------------+
  77 | frProper()            | 文字式から固有名詞として適切に大文字化された文字列を返します。                                |
  78 +-----------------------+-----------------------------------------------------------------------------------------------+
  79 | frReplicate()         | 指定された文字式を指定回数反復したものを文字列として返します。                                |
  80 +-----------------------+-----------------------------------------------------------------------------------------------+
  81 | frRTrim()             | 指定された文字式から文末の空白文字または構文解析文字を全て削除します。                        |
  82 +-----------------------+-----------------------------------------------------------------------------------------------+
  83 | frSetIfEmpty()        | 変数の値が空、 NULL または 0 ならば変数の値を設定します。                                     |
  84 +-----------------------+-----------------------------------------------------------------------------------------------+
  85 | frSetSeparatorTo()    | 数値位置分離記号として使用する文字を指定します。                                              |
  86 +-----------------------+-----------------------------------------------------------------------------------------------+
  87 | frSpace()             | 指定された個数の空白文字で構成されている文字列を返します。                                    |
  88 +-----------------------+-----------------------------------------------------------------------------------------------+
  89 | frStr()               | 数値の式と等価な文字を返します。                                                              |
  90 +-----------------------+-----------------------------------------------------------------------------------------------+
  91 | frStringToList()      | 指定された文字列の内容でリストを作成します。                                                  |
  92 +-----------------------+-----------------------------------------------------------------------------------------------+
  93 | frStrTran()           | 文字式に対して第二文字式を検索を行い、各出現位置を第三文字式で置換します。                    |
  94 +-----------------------+-----------------------------------------------------------------------------------------------+
  95 | frStuff()             | 式の文字数を指定することにより別の文字式を新しい文字列で置換したものを返します。              |
  96 +-----------------------+-----------------------------------------------------------------------------------------------+
  97 | frSubStr()            | 指定された文字式の始点位置から指定された文字数までを返します。                                |
  98 +-----------------------+-----------------------------------------------------------------------------------------------+
  99 |                       | 総計を行った結果の文字式から文字列を返します。                                                |
 100 +-----------------------+-----------------------------------------------------------------------------------------------+
 101 | frTransform()         | 書式コードにより決定された書式で式から文字列を返します。                                      |
 102 +-----------------------+-----------------------------------------------------------------------------------------------+
 103 | frVal()               | 数字で構成された文字式から数値を返します。                                                    |
 104 +-----------------------+-----------------------------------------------------------------------------------------------+
 105 | frVarType()           | 式のデータ型を返します。                                                                      |
 106 +-----------------------+-----------------------------------------------------------------------------------------------+
 107
 108 .. index::
 109      pair: FoxRing 関数リファレンス; frAbs() 関数
 110
 111 frAbs() 関数
 112 ============
 113
 114 .. code-block:: none
 115
 116     * 文法    : lnReturnValue = frAbs(tnExpression)
 117     * 説明    : 指定された数値式の絶対値を返します。
 118     *         :
 119     * 引数    : <tnExpression>
 120     *         : frAbs() の返値は数値式を指定して
 121     *         : 得られた絶対値です。
 122     * 返値    : <lnReturnValue>
 123     *         : 指定された数値式の絶対値を返します。
 124
 125 .. index::
 126      pair: FoxRing 関数リファレンス; frAsc() 関数
 127
 128 frAsc() 関数
 129 ============
 130
 131 .. code-block:: none
 132
 133          * 文法    : lnReturnValue = frAsc(tcExpression)
 134          * 説明    : 文字式の左端にある文字に対して ANSI 値を返します。
 135          *         :
 136          * 引数    : <tcExpression>
 137          *         : frAsc() で ANSI 値を返したい文字のある文字式を指定します。
 138          *         :
 139          *         : tcExpression にある先頭の１文字目以降は
 140          *         : frAsc() により無視されます。
 141          * 返値    : <lnReturnValue>
 142          *         : 現在のコードページの文字テーブルに
 143          *         : 関連づけられている文字位置を返します。
 144          *         : 文字ごとに 0 ～ 255 までの範囲内で
 145          *         : 固有の ANSI 値があります
 146
 147 .. index::
 148      pair: FoxRing 関数リファレンス; frAddBs() 関数
 149
 150 frAddBs() 関数
 151 ==============
 152
 153 .. code-block:: none
 154
 155      * 文法    : lcReturnValue = frAddBs(tcPath)
 156      * 説明    : パス表現にバックスラッシュを追加します (必要ならば)。
 157      *         :
 158      * 引数    : <tcPath>
 159      *         : バックスラッシュを追加するパス名を指定します。
 160      *         :
 161      * 返値    : <lcReturnValue> バックスラッシュを追加したパス名を返します。
 162
 163 .. index::
 164      pair: FoxRing 関数リファレンス; frAt() 関数
 165
 166 frAt() 関数
 167 ===========
 168
 169 .. code-block:: none
 170
 171      * 文法    : lnPos = frAt(tcToSearch, tcString, tnOccurrence)
 172      * 説明    : 文字式に出現する別の文字式を検索します。
 173      *         :
 174      *         : frAt() による検索では英数大小文字を区別します。
 175      *         :
 176      * 引数    : <tcToSearch>
 177      *         : <tcString> に対して検索する文字式を指定します。
 178      *         :
 179      *         : <tcString>
 180      *         : <tcToSearch> に対して検索する文字式を指定します。
 181      *         :
 182      *         : <tnOccurrence>
 183      *         : <tcString> に対する <tcToSearch> の検索において
 184      *         : １番目、２番目、３番目など出現位置を指定します。
 185      *         :
 186      *         : デフォルトでは、 frAt() は <tcToSearch> (tnOccurrence = 1) の
 187      *         : 最初の出現位置を検索します。
 188      * 返値    : 数値。 frAt() は左端の文字を始点として、
 189      *         : 文字式、または別の文字式内にあるメモフィールド、
 190      *         : メモフィールドにある最初の文字の位置を示す整数を返します。
 191      *         :
 192      *         : 式やフィールドが見つからない、
 193      *         : または <tnOccurrence> が <tcToSearch> 内の
 194      *         : <tcString> よりも出現回数が多いならばfrAt() は
 195      *         : 0 を返します。
 196      *         :
 197
 198 .. index::
 199      pair: FoxRing 関数リファレンス; frAtC() 関数
 200
 201 frAtC() 関数
 202 ============
 203
 204 .. code-block:: none
 205
 206      * 文法    : lnPos = frAtC(tcToSearch, tcString, tnOccurrence)
 207      * 説明    : 文字式に出現する別の文字式を検索します。
 208      *         :
 209      *         : frAtC() による検索では英数大小文字を区別しません。
 210      *         :
 211      * 引数    : <tcToSearch>
 212      *         : <tcString> に対して検索する文字式を指定します。
 213      *         :
 214      *         : <tcString>
 215      *         : <tcToSearch> に対して検索する文字式を指定します。
 216      *         :
 217      *         : <tnOccurrence>
 218      *         : <tcString> に対する <tcToSearch> の検索において
 219      *         : １番目、２番目、３番目など出現位置を指定します。
 220      *         :
 221      *         : デフォルトでは、 frAtC() は <tcToSearch> (tnOccurrence = 1) の
 222      *         : 最初の出現位置を検索します。
 223      * 返値    : 数値。 frAtC() は左端の文字を始点として、
 224      *         : 文字式、または別の文字式内にあるメモフィールド、
 225      *         : メモフィールドにある最初の文字の位置を示す整数を返します。
 226      *         :
 227      *         : 式やフィールドが見つからない、
 228      *         : または <tnOccurrence> が <tcToSearch> 内の
 229      *         : <tcString> よりも出現回数が多いならばfrAtC() は
 230      *         : 0 を返します。
 231      *         :
 232
 233 .. index::
 234      pair: FoxRing 関数リファレンス; frChr() 関数
 235
 236 frChr() 関数
 237 ============
 238
 239 .. code-block:: none
 240
 241      * 文法    : lcReturnValue = frChr(tnExpression)
 242      * 説明    : ANSI コードを数値で指定して関連づけられている文字を返します。
 243      *         :
 244      * 引数    : <tnExpression>
 245      *         : frChr() は 0 ～ 255 までの範囲内の数値に対応する
 246      *         : ANSI 文字を指定します。
 247      * 返値    : <lcReturnValue>
 248      *         : 現在のコードページの文字テーブルに
 249      *         : 関連づけられている文字の数値位置に
 250      *         : 対応する文字を返します。
 251      *         :
 252      * 注釈    : tnExpression は 0 ～ 255 までの範囲内を必ず指定してください。
 253
 254 .. index::
 255      pair: FoxRing 関数リファレンス; frEmpty() 関数
 256
 257 frEmpty() 関数
 258 ==================
 259
 260 .. code-block:: none
 261
 262      * 文法    : llReturnValue = frEmpty(tuExpression)
 263      * 説明    : 式の評価が空であるかどうかを判定します。
 264      *         :
 265      * 引数    : <tuExpression>
 266      *         : EMPTY() で評価する式を指定します。
 267      *         : 式には数値、文字、または論理型を指定できます。
 268      *         :
 269      *         :
 270      * 返値    : <llReturnValue> 論理
 271
 272 .. index::
 273      pair: FoxRing 関数リファレンス; frFile() 関数
 274
 275 frFile() 関数
 276 =============
 277
 278 .. code-block:: none
 279
 280      * 文法    : llReturnValue = frFile(tcFileName, tnFlag)
 281      * 説明    : 指定されたファイルがディスクにあるかどうかを確認します。
 282      *         :
 283      * 引数    : <tcFileName>
 284      *         : 指定されたファイル名で確認します。
 285      *         : tcFileName にはファイルの拡張子が必要です。
 286      *         : ディレクトリでのファイル検索、
 287      *         : またはカレントディレクトリ以外のドライブ、
 288      *         : あるいはドライブをファイル名として
 289      *         : パスと一緒に指定できます。
 290      *         :
 291      *         : <tnFlag>
 292      *         : tnFlag は将来の互換性ために予約されています。
 293      *         : このバージョンでは、ディスクにファイルがあるときは
 294      *         : 常に true を返します。
 295      * 返値    : <llReturnValue> 論理
 296      *         : True ならばファイルはディスクにあります。
 297      *         : False ならばファイルはディスクにありません。
 298
 299 .. index::
 300      pair: FoxRing 関数リファレンス; frFileToStr() 関数
 301
 302 frFileToStr() 関数
 303 ==================
 304
 305 .. code-block:: none
 306
 307      * 文法    : lcReturnValue = frFileToStr(tcFileName)
 308      * 説明    : ファイルの内容を文字列として返します。
 309      *         :
 310      * 引数    : <tcFileName>
 311      *         : ファイルの内容を文字列として返したい
 312      *         : ファイル名を指定します。
 313      *         : ファイル現在のデフォルトディレクトリ以外の
 314      *         : ディレクトリにある場合は、
 315      *         : ファイル名と一緒にパスを指定してください。
 316      *         :
 317      * 返値    : <lcReturnValue>
 318      *         : 指定されたファイル内容がある文字列。
 319      *         :
 320
 321 .. index::
 322      pair: FoxRing 関数リファレンス; frStr() 関数
 323
 324 frStr() 関数
 325 ============
 326
 327 .. code-block:: none
 328
 329      * 文法    : lcReturnValue = frStr(tnValue, tnLen, tnDec)
 330      * 説明    : 数値の式と等価な文字を返します。
 331      *         :
 332      * 引数    : <tnValue>
 333      *         : 評価する数値の式を指定します。
 334      *         :
 335      *         : <tnLen>
 336      *         : 返された文字列の長さを指定します。
 337      *         : tnLen が 0 ならば、デフォルトは 10 文字になります。
 338      *         : tnLen < 0 ならば、 文字列の長さは数値と同じです。
 339      *         :
 340      *         : 注意
 341      *         : 式に小数点がある場合は、小数点は１文字として、
 342      *         : そして、文字列の各桁も１文字として長さに算入されます。
 343      *         :
 344      *         : <tnDec>
 345      *         : 返された文字列にある小数位の桁数の数値を指定します。
 346      *         :
 347      *         : tnDec を使って小数位の桁数の数字を指定するには、
 348      *         : nLength を有する必要があります。nDecimalPlaces を省略した場合、
 349      *         : 小数位の桁数の数字はゼロ (0) がデフォルトになります。
 350      *         :
 351      * 返値    : 文字列データ型。 frStr() は指定された数値の式と
 352      *         : 等価な文字列を返します。
 353      *         :
 354      *         : 特定の条件により、 frStr() は次のことを返すことがあります:
 355      *         : tnValue よりも少ない小数位の桁数を指定した場合は返値は切り上げられます。
 356      *         : 丸め込みの処理結果が近似小数位の桁数でなく上方ならば、
 357      *         : ROUND( ) による処理が入ります。
 358      *         : 詳細情報は、 ROUND( ) 関数を参照してください。
 359      *         :
 360      *         : nExpression が整数であり、nExpression の桁数が
 361      *         : nLength 以下ならば、frStr( ) は数値の
 362      *         : 桁あふれを示すためにアスタリスク文字列を返します。
 363      *         :
 364      *         : nExpression が小数点であり、nExpression の残り小数点の桁数が
 365      *         : nLength 以下または等しいならば、frStr() は
 366      *         : 数値の桁あふれを示すためにアスタリスク文字列を返します。
 367      *         :
 368      *         : nLength が nExpression で評価された値の長さよりも長いならば、
 369      *         : frStr() は先頭を空白文字で桁揃えした文字列を返します。
 370      *         :
 371      *         : nExpression が数値あるいは浮動小数点数型を有しており、
 372      *         : nLength が nExpression の桁数以下ならば、
 373      *         : frStr() は指数表現を用いた値を返します。
 374      *         :
 375
 376 .. index::
 377      pair: FoxRing 関数リファレンス; frSetIfEmpty() 関数
 378
 379 frSetIfEmpty() 関数
 380 ===================
 381
 382 .. code-block:: none
 383
 384      * 文法    : tuReturnValue = frSetIfEmpty(tuValue, tuNewValue)
 385      * 説明    : 変数の値が空、 NULL または 0 ならば
 386      *         : 変数の値を設定します。
 387      * 引数    : <tuValue>
 388      *         : 評価を行う値。
 389      *         :
 390      *         : <tuNewValue>
 391      *         : tuValue が空ならば変数の値を設定します。
 392      *         :
 393      * 返値    : tuValue が空ならば tuNewValue を、
 394      *         : それ以外は元値を返します。
 395      * 注釈    : この関数は Visual FoxPro にはありません。
 396
 397 .. index::
 398      pair: FoxRing 関数リファレンス; frSpace() 関数
 399
 400 frSpace() 関数
 401 ==============
 402
 403 .. code-block:: none
 404
 405      * 文法    : lcReturnValue = frSpace(tnSpaces)
 406      * 説明    : 指定された個数の空白文字で構成されている文字列を返します。
 407      *         :
 408      * 引数    : <tnSpaces>
 409      *         : frSpace() は指定された個数の空白文字を返します。
 410      *         :
 411      * 返値    : <lcReturnValue>
 412      *         : 文字
 413
 414 .. index::
 415      pair: FoxRing 関数リファレンス; frInList() 関数
 416
 417 frInList() 関数
 418 ===============
 419
 420 .. code-block:: none
 421
 422      * 文法    : llReturnValue = frInList(tuExpression, taList)
 423      * 説明    : 式が別式にある式集合と一致する
 424      *         : 式であるかどうか決定します。
 425      * 引数    : <tuExpression>
 426      *         : リストで検索する式を frInList() へ指定します。
 427      *         :
 428      *         : <taList>
 429      *         : 検索する式のリストを指定します。
 430      *         : リストには最低でも１要素が存在する必要があります。
 431      *         : 式のリストにある式は同一データ型である
 432      *         : 必要はありません。
 433      *         :
 434      * 返値    : <luReturnValue> Null または論理値。
 435
 436 .. index::
 437      pair: FoxRing 関数リファレンス; frForcePath() 関数
 438
 439 frForcePath() 関数
 440 ==================
 441
 442 .. code-block:: none
 443
 444      * 文法    : lcReturnValue = frForcePath(tcFileName, tcPath)
 445      * 説明    : 古いものの代わりに置換された新しい
 446      *         : パス名を使用したファイル名を返します。
 447      * 引数    : <tcFileName>
 448      *         : 新しいパスを取得するファイル名 (パスあるいは拡張子の
 449      *         : 有無にかかわらず) を指定します。
 450      *         : <tcPath>
 451      *         : tcFileName の新しいパスを指定します。
 452      *         :
 453      * 返値    : <lcReturnValue>
 454      *         : 古いものの代わりに置換された新しい
 455      *         : パス名を使用したファイル名を返します。
 456
 457 .. index::
 458      pair: FoxRing 関数リファレンス; frAllTrim() 関数
 459
 460 frAllTrim() 関数
 461 ================
 462
 463 .. code-block:: none
 464
 465         文法  : lcReturnValue = frAllTrim(tcExpression, tcCharacter)
 466
 467
 468 .. index::
 469      pair: FoxRing 関数リファレンス; frLTrim() 関数
 470
 471 frLTrim() 関数
 472 ==============
 473
 474 .. code-block:: none
 475
 476         文法  : lcRet = frLTrim(tcExpression, tcCharacter)
 477
 478 .. index::
 479      pair: FoxRing 関数リファレンス; frJustDrive() 関数
 480
 481 frJustDrive() 関数
 482 ==================
 483
 484 .. code-block:: none
 485
 486          * 文法       : lcReturnValue = frJustDrive(tcPath)
 487          * 説明       : 絶対パスからドライブ文字を返します。
 488          *              :
 489          * 引数       : <tcPath>
 490          *              : ドライブ文字を求めたい絶対パス名を指定します。
 491          *              :
 492          * 返値       : <lcReturnValue>
 493          *              : 絶対パスからドライブ文字を返します。
 494
 495 .. index::
 496      pair: FoxRing 関数リファレンス; frJustExt() 関数
 497
 498 frJustExt() 関数
 499 ================
 500
 501 .. code-block:: none
 502
 503          * 文法       : lcReturnValue = frJustExt(tcPath)
 504          * 説明       : 絶対パスからファイル拡張子の文字列を返します。
 505          *              :
 506          * 引数       : <tcPath>
 507          *              : 拡張子を求めたいファイルのあるフルパスを指定します。
 508          *              :
 509          * 返値       : <lcReturnValue>
 510          *              : 絶対パスからファイル拡張子の文字列を返します。
 511          *              :
 512
 513 .. index::
 514      pair: FoxRing 関数リファレンス; frJustStem() 関数
 515
 516 frJustStem() 関数
 517 =================
 518
 519 .. code-block:: none
 520
 521          * 文法       : lcReturnValue = frJustStem(tcPath)
 522          * 説明       : 絶対パスとファイル名からステム名 (拡張子の前のファイル名) を
 523          *              : 返します。
 524          * 引数       : <tcPath>
 525          *              : ステムを求めたいファイル名 (パスを含む)を指定します。
 526          *              :
 527          * 返値       : <lcReturnValue>
 528          *              : 絶対パスからファイル名のステム名を返します。
 529
 530 .. index::
 531      pair: FoxRing 関数リファレンス; frRTrim() 関数
 532
 533 frRTrim() 関数
 534 ==============
 535
 536 .. code-block:: none
 537
 538          文法 : lcRet = frRTrim(tcExpression, tcCharacter)
 539
 540 .. index::
 541      pair: FoxRing 関数リファレンス; frJustPath() 関数
 542
 543 frJustPath() 関数
 544 =================
 545
 546 .. code-block:: none
 547
 548         文法  : tcReturnValue = frJustPath(tcExpression)
 549
 550 .. index::
 551      pair: FoxRing 関数リファレンス; frForceExt() 関数
 552
 553 frForceExt() 関数
 554 =================
 555
 556 .. code-block:: none
 557
 558         文法  : tcReturnValue = frForceExt(tcFileName, tcNewExtension)
 559
 560 .. index::
 561      pair: FoxRing 関数リファレンス; frALines() 関数
 562
 563 frALines() 関数
 564 ===============
 565
 566 .. code-block:: none
 567
 568         文法  : tnReturnValue = frALines(taList, tcExpression, tcSeparator)
 569
 570 .. index::
 571      pair: FoxRing 関数リファレンス; frJustFName() 関数
 572
 573 frJustFName() 関数
 574 ==================
 575
 576 .. code-block:: none
 577
 578         文法  : tcReturnValue = frJustFName(tcExpression)
 579
 580 .. index::
 581      pair: FoxRing 関数リファレンス; frPadL() 関数
 582
 583 frPadL() 関数
 584 =============
 585
 586 .. code-block:: none
 587
 588         文法  : tcReturnValue = frPadL(tcString, tnLen, tcChar)
 589
 590 .. index::
 591      pair: FoxRing 関数リファレンス; frPadR() 関数
 592
 593 frPadR() 関数
 594 =============
 595
 596 .. code-block:: none
 597
 598         文法  : tcReturnValue = frPadR(tcString, tnLen, tcChar)
 599
 600 .. index::
 601      pair: FoxRing 関数リファレンス; frProper() 関数
 602
 603 frProper() 関数
 604 ===============
 605
 606 .. code-block:: none
 607
 608      * 文法    : tcReturnValue = frProper(tcExpression)
 609      * 説明    : 文字式から固有名詞として適切に
 610      *         : 大文字へ変換した文字列を返します。
 611      * 引数    : <tcExpression>
 612      *         :  frProper() には大文字へ変換したい
 613      *         : 文字列を文字式を指定します。
 614      * 返値    : <tcReturnValue>
 615
 616 .. index::
 617      pair: FoxRing 関数リファレンス; frReplicate() 関数
 618
 619 frReplicate() 関数
 620 ==================
 621
 622 .. code-block:: none
 623
 624         文法  : tcReturnValue = frReplicate(tcString, tnTimes)
 625
 626 .. index::
 627      pair: FoxRing 関数リファレンス; frLen() 関数
 628
 629 frLen() 関数
 630 ============
 631
 632 .. code-block:: none
 633
 634         文法  : tnReturnValue = frLen(tcString)
 635
 636 .. index::
 637      pair: FoxRing 関数リファレンス; frStuff() 関数
 638
 639 frStuff() 関数
 640 ==============
 641
 642 .. code-block:: none
 643
 644      * 文法    : tcReturnValue = frStuff(tcExpression, tnStartRep,
 645                                          tnCharRep,    tcToReplace)
 646      * 説明    : 式の文字数を指定することにより
 647      *         : 別の文字式を新しい文字列で置換したものを返します。
 648      *         :
 649      * 引数    : <tcExpression>
 650      *         : 置換対象の文字式を指定します。
 651      *         :
 652      *         : <tnStartRep>
 653      *         : <tcExpression> の置換開始位置を指定します。
 654      *         :
 655      *         : <tnCharRep>
 656      *         : 置換文字数を指定します。
 657      *         : <tnCharRep> が０ ならば、変換文字列 <tcToReplace> には
 658      *         : <tcExpression>が挿入されます。
 659      *         :
 660      *         : <tcToReplace>
 661      *         : 置換文字式を指定します。
 662      *         : <tcToReplace> が空文字列ならば、指定された文字数により
 663      *         : <tnCharRep> は <tcExpression> から削除されます。
 664      *         :
 665      * 返値    : 文字
 666
 667 .. index::
 668      pair: FoxRing 関数リファレンス; frSubStr() 関数
 669
 670 frSubStr() 関数
 671 ===============
 672
 673 .. code-block:: none
 674
 675         文法  : tcReturnValue = frSubStr(tcString, tnInitialPosition, tnNumberBytes)
 676
 677 .. index::
 678      pair: FoxRing 関数リファレンス; frStrTran() 関数
 679
 680 frStrTran() 関数
 681 ================
 682
 683 .. code-block:: none
 684
 685         文法  : tcReturnValue = frStrTran(tcString, tcOldString, tcNewString)
 686
 687 .. index::
 688      pair: FoxRing 関数リファレンス; frListToString() 関数
 689
 690 frListToString() 関数
 691 =====================
 692
 693 .. code-block:: none
 694
 695          * 文法       : lcRet = frListToString(taList)
 696          * 注釈       : この関数は Visual FoxPro にはありません。
 697
 698 .. index::
 699      pair: FoxRing 関数リファレンス; frInt() 関数
 700
 701 frInt() 関数
 702 ============
 703
 704 .. code-block:: none
 705
 706         文法          : lnInt = frInt(tnExpression)
 707
 708 .. index::
 709      pair: FoxRing 関数リファレンス; frStringToList() 関数
 710
 711 frStringToList() 関数
 712 =====================
 713
 714 .. code-block:: none
 715
 716          * 文法       : laList = frStringToList(tcExpression)
 717          * 注釈       : この関数は Visual FoxPro にはありません。
 718
 719 .. index::
 720      pair: FoxRing 関数リファレンス; frIIf() 関数
 721
 722 frIIf() 関数
 723 ============
 724
 725 .. code-block:: none
 726
 727      * 文法    : luReturnValue = frIIf(tlExpression, tuReturnIfTrue, tuReturnIfFalse)
 728      * 説明    : 論理式の値により２つの値のうち１つを返します。
 729      *         :
 730      * 引数    : <tlExpression>
 731      *         : frIIf() で評価する論理式を指定します。
 732      *         :
 733      *         : <tuReturnTrue>, <tuReturnFalse>
 734      *         : tlExpression の評価が True ならば tuReturnIfTrue を、
 735      *         : 未評価ならば tuReturnIfFalse が返されます。
 736      *         : tlExpression の評価が False または Null ならば tuReturnIfFalse を、
 737      *         : 未評価ならば tuReturnIfTrue が返されます。
 738      *         :
 739      * 返値    : <luReturnValue> は <tuReturnIfTrue> または <tuReturnIfFalse> により定義済み。
 740
 741 .. index::
 742      pair: FoxRing 関数リファレンス; frVal() 関数
 743
 744 frVal() 関数
 745 ============
 746
 747 .. code-block:: none
 748
 749      * 文法    : luReturnValue = frVal(tcExpression)
 750      * 説明    : 数字で構成された文字式から数値を返します。
 751      *         :
 752      * 引数    : <tcExpression>
 753      *         : 16 までの数字で構成された文字式を指定します。
 754      *         :
 755      * 返値    : <tnValue>
 756      *         : 数値を返します。
 757
 758 .. index::
 759      pair: FoxRing 関数リファレンス; frBetween() 関数
 760
 761 frBetween() 関数
 762 ================
 763
 764 .. code-block:: none
 765
 766      * 文法    : luReturnValue = frBetween(tuTestValue, tuLowValue, tuHighValue)
 767      * 説明    : 式値が同一型の二式値の間にあるかどうかを確認します。
 768      *         :
 769      *         :
 770      *         :
 771      * 引数    : <tuTestValue>
 772      *         : 評価する式を指定します。
 773      *         :
 774      *         : <tuLowValue>
 775      *         : 低い範囲値を指定します。
 776      *         :
 777      *         : <tuHighValue>
 778      *         : 高い範囲値を指定します。
 779      *         :
 780      * 返値    : <luReturnValue>
 781      *         : 論理順序の NULL 値を返します。
 782
 783 .. index::
 784      pair: FoxRing 関数リファレンス; frSetSeparatorTo() 関数
 785
 786 frSetSeparatorTo() 関数
 787 =======================
 788
 789 .. code-block:: none
 790
 791      * 文法    : frSetSeparatorTo(tuExpression)
 792      * 説明    : 数値位置分離記号として使用する文字を指定します。
 793      *         :
 794      * 引数    : <tuExpression>
 795      *         : 数値位置分離記号として使用する文字を指定します。
 796      *         :
 797      *         : frSetSeparatorTo() は数値位置分離記号を
 798      *         : デフォルトからの変更で使用します。
 799      *         : 例えば、空白文字 " "  またはカンマ "," です。
 800      *         : デフォルト値へ戻すには frSetSeparatorTo(Null) を指定します
 801      *         :
 802      * 返値    : なし
 803
 804 .. index::
 805      pair: FoxRing 関数リファレンス; frTransform() 関数
 806
 807 frTransform() 関数
 808 ==================
 809
 810 .. code-block:: none
 811
 812      * 文法    : tcReturnValue = frTransform(tuExpression, tcFormatCodes)
 813      * 説明    : 書式コードにより決定された書式で式から文字列を返します。
 814      *         :
 815      * 引数    : <tuExpression>
 816      *         : 式の書式を指定します。
 817      *         :
 818      *         : <tcFormatCodes>
 819      *         : 式の書式処理方法を決定するために
 820      *         : １つ以上の書式コードを指定します。
 821      *         :
 822      * 返値    : <tcReturnValue>
 823
 824 これは tcFormatCodes で利用できる書式コードのリスト表です。
 825
 826 .. csv-table::
 827         :header: "書式コード", "説明"
 828         :widths:       20,     80
 829
 830         "@!",   "文字列にある文字を全て大文字へ変換します。"
 831         "@T",   "文字の値から先頭と文末にある空白文字を除去します。"
 832         "@B",   "数値データを表示範囲内で左揃えします。"
 833         "@L",   "数値の文字列データに対して先頭を 0 で桁合わせします。"
 834         "@C",   "掛け売りを示すために正数値に CR を追加します。"
 835         "@X",   "借り方を示すために負数値に DB を追加します。"
 836
 837 .. index::
 838      pair: FoxRing 関数リファレンス; frVarType() 関数
 839
 840 frVarType() 関数
 841 ================
 842
 843 .. code-block:: none
 844
 845      * 文法    : lcRet = frVarType(tuExpression)
 846      * 説明    : 式のデータ型を返します。
 847      *         :
 848      * 引数    : <tuExpression>
 849      *         : データ型を返したい式を指定します。
 850      *         : frVartype() は式のデータ型を示す一文字を返します。
 851      *         :
 852      *         : この表は frVarType() が返すデータ型のリストです。
 853      *         :
 854      *         :
 855      *         : -------------------   -------------------------------------
 856      *         : 返値                  データ型
 857      *         : -------------------   -------------------------------------
 858      *         : C                     文字
 859      *         : N                     数値
 860      *         : A                     リスト
 861      *         : O                     オブジェクト
 862      *         : U                     未定義型
 863      *         : -------------------   -------------------------------------
 864      *         :
 865      * 返値    : 文字
 866
 867 .. index::
 868      pair: FoxRing 関数リファレンス; 用例
 869
 870 用例
 871 ====
 872
 873 .. code-block:: ring
 874
 875         Load "foxring.ring"
 876
 877
 878         mf = new frFunctions
 879
 880         /*----------------------------------------------------------*/
 881          * frProper() サンプル
 882         /*----------------------------------------------------------*/
 883
 884         lcStr1 = "ring is a good language"
 885         ?mf.frProper(lcStr1)
 886         ?mf.frProper(Upper(lcStr1))
 887
 888
 889         /*----------------------------------------------------------*/
 890          * frStuff() サンプル
 891         /*----------------------------------------------------------*/
 892
 893         lcStr1 = "abcdefghijklm"
 894         lcStr2 = "12345"
 895
 896         // 挿入
 897         ?mf.frStuff(lcStr1, 4, 0, lcStr2)
 898         // 置換
 899         ?mf.frStuff(lcStr1, 4, 3, lcStr2)
 900         // 削除
 901         ?mf.frStuff(lcStr1, 4, 6, "")
 902         // 置換と挿入
 903         ?mf.frStuff(lcStr1, 4, 1, lcStr2)
 904         // 置換と削除
 905         ?mf.frStuff(lcStr1, 4, 4, lcStr2)
 906         // 置換、残りを削除
 907         ?mf.frStuff(lcStr1, 4, Len(lcStr1), lcStr2)
 908
 909         /*----------------------------------------------------------*/
 910
 911
 912
 913         ?mf.frAbs(-45)
 914         ?mf.frAbs(10-30)
 915         ?mf.frAbs(30-10)
 916
 917         lcNumber1 = 40
 918         lcNumber2 = 2
 919
 920         ?mf.frAbs(lcNumber2-lcNumber1)
 921
 922
 923
 924
 925         lcCompletFileName = "C:\ring\docs\source\contribute.txt"
 926
 927         ?mf.frFile(lcCompletFileName, Null)
 928         if mf.frFile(lcCompletFileName, Null) {
 929           ?mf.frFileToStr(lcCompletFileName)
 930         else
 931           ?"File does not exist"
 932         }
 933
 934         lcNewPath = "C:\ring_2\docs\source\"
 935         ?mf.frJustExt(lcCompletFileName)
 936         ?mf.frJustDrive(lcCompletFileName)
 937         ?mf.frJustStem(lcCompletFileName)
 938         ?mf.frForcePath(lcCompletFileName, lcNewPath)
 939         ?mf.frTransform("    Ring is a good language    ",
 940                         "@! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
 941         ?mf.frAllTrim("    Ring is a good language    ", Null)
 942         ?mf._version
 943         lnValue = 3125.54
 944         ?mf.frTransform(lnValue, "@B")+ "Euros"
 945         ?mf.frTransform(lnValue, "@C 9999,999,999,999.999")
 946         mf.frSetSeparatorTo(" ")
 947         ?mf.frTransform(lnValue, "9999,999,999,999.999")
 948         ?mf.frInt(lnValue)
 949         ?mf.frForceExt("teste", "dbf")
 950         // 書式コード "@L" を frTransform() 関数へ追加
 951         ?mf.frTransform("123", "@L 999999")
 952         ?mf.frTransform(123, "@L 999999")
 953