~ubuntu-branches/ubuntu/karmic/gnustep-base/karmic

« back to all changes in this revision

Viewing changes to Documentation/gsdoc/NSString.html

  • Committer: Bazaar Package Importer
  • Author(s): Eric Heintzmann
  • Date: 2005-04-17 00:14:38 UTC
  • mfrom: (1.2.1 upstream) (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050417001438-enf0y07c9tku85z1
Tags: 1.10.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head>
2
 
 <title>NSString</title>
3
 
</head>
4
 
<body>
5
 
<a href ="NSSet.html">[Previous] </a>
6
 
<a href ="Base.html">[Up] </a>
7
 
<a href ="NSTask.html">[Next] </a>
8
 
<h1>NSString</h1>
9
 
<h3>Authors </h3>
10
 
 <dl>
11
 
<dt><a href ="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
12
 
<dd>
13
 
<dt>James Dessart
14
 
<dd>
15
 
</dl>
16
 
<p>Version: $Revision: 1.19 $</p>
17
 
<p>Date: $Date: 2001/12/12 14:10:13 $</p>
18
 
<h2><a name ="cont-0">NSString</a></h2>
19
 
<h2><a name ="NSString">NSString</a></h2>
20
 
<p><b>Declared in: </b> Foundation/NSString.h</p>
21
 
<p><b>Inherits from: </b> NSObject</p>
22
 
<p><b>Conforms to: </b> NSCoding
23
 
</p>
24
 
<hr>
25
 
 
26
 
          <p>
27
 
 
28
 
            NSString objects represent an immutable string of characters.
29
 
            NSString itself is an abstract class which provides factory
30
 
            methods to generate objects of unspecified subclasses.
31
 
          </p>
32
 
 
33
 
          <p>
34
 
 
35
 
            A constant NSString can be created using the following syntax:
36
 
            <code>@"..."</code>, where the contents of the quotes are the
37
 
            string, using only ASCII characters.
38
 
          </p>
39
 
 
40
 
          <p>
41
 
 
42
 
            To create a concrete subclass of NSString, you must have your
43
 
            class inherit from NSString and override at least the two
44
 
            primitive methods - length and characterAtIndex:
45
 
          </p>
46
 
 
47
 
          <p>
48
 
 
49
 
            In general the rule is that your subclass must override any
50
 
            initialiser that you want to use with it.  The GNUstep
51
 
            implementation relaxes that to say that, you may override
52
 
            only the <em>designated initialiser</em> and the other
53
 
            initialisation methods should work.
54
 
          </p>
55
 
 
56
 
        
57
 
<h2>Instance Variables </h2>
58
 
<ul>
59
 
</ul>
60
 
<h2>Methods </h2>
61
 
<ul>
62
 
<li ><a href ="NSString.html#method-0">+availableStringEncodings</a>
63
 
<li ><a href ="NSString.html#method-1">+defaultCStringEncoding</a>
64
 
<li ><a href ="NSString.html#method-37">+getLineStart:end:contentsEnd:</a>
65
 
<li ><a href ="NSString.html#method-60">+lineRangeForRange:</a>
66
 
<li ><a href ="NSString.html#method-2">+localizedNameOfStringEncoding:</a>
67
 
<li ><a href ="NSString.html#method-3">+localizedStringWithFormat:</a>
68
 
<li ><a href ="NSString.html#method-4">+pathWithComponents:</a>
69
 
<li ><a href ="NSString.html#method-5">+string</a>
70
 
<li ><a href ="NSString.html#method-8">+stringWithCString:</a>
71
 
<li ><a href ="NSString.html#method-9">+stringWithCString:</a>
72
 
<li ><a href ="NSString.html#method-6">+stringWithCharacters:length:</a>
73
 
<li ><a href ="NSString.html#method-7">+stringWithContentsOfFile:</a>
74
 
<li ><a href ="NSString.html#method-10">+stringWithFormat:</a>
75
 
<li ><a href ="NSString.html#method-11">+stringWithString:</a>
76
 
<li ><a href ="NSString.html#method-22">-cString</a>
77
 
<li ><a href ="NSString.html#method-23">-cStringLength</a>
78
 
<li ><a href ="NSString.html#method-12">-canBeConvertedToEncoding:</a>
79
 
<li ><a href ="NSString.html#method-13">-capitalizedString</a>
80
 
<li ><a href ="NSString.html#method-14">-caseInsensitiveCompare:</a>
81
 
<li ><a href ="NSString.html#method-15">-characterAtIndex:</a>
82
 
<li ><a href ="NSString.html#method-16">-commonPrefixWithString:</a>
83
 
<li ><a href ="NSString.html#method-17">-compare:</a>
84
 
<li ><a href ="NSString.html#method-18">-compare:</a>
85
 
<li ><a href ="NSString.html#method-19">-compare:options:range:</a>
86
 
<li ><a href ="NSString.html#method-20">-completePathIntoString:caseSensitive:matchesIntoArray:</a>
87
 
<li ><a href ="NSString.html#method-21">-componentsSeparatedByString:</a>
88
 
<li ><a href ="NSString.html#method-24">-dataUsingEncoding:</a>
89
 
<li ><a href ="NSString.html#method-25">-dataUsingEncoding:allowLossyConversion:</a>
90
 
<li ><a href ="NSString.html#method-26">-description</a>
91
 
<li ><a href ="NSString.html#method-27">-doubleValue</a>
92
 
<li ><a href ="NSString.html#method-28">-fastestEncoding</a>
93
 
<li ><a href ="NSString.html#method-29">-fileSystemRepresentation</a>
94
 
<li ><a href ="NSString.html#method-30">-floatValue</a>
95
 
<li ><a href ="NSString.html#method-33">-getCString:</a>
96
 
<li ><a href ="NSString.html#method-34">-getCString:maxLength:</a>
97
 
<li ><a href ="NSString.html#method-35">-getCString:maxLength:range:remainingRange:</a>
98
 
<li ><a href ="NSString.html#method-31">-getCharacters:</a>
99
 
<li ><a href ="NSString.html#method-32">-getCharacters:</a>
100
 
<li ><a href ="NSString.html#method-36">-getFileSystemRepresentation:maxLength:</a>
101
 
<li ><a href ="NSString.html#method-39">-hasPrefix:</a>
102
 
<li ><a href ="NSString.html#method-40">-hasSuffix:</a>
103
 
<li ><a href ="NSString.html#method-38">-hash</a>
104
 
<li ><a href ="NSString.html#method-41">-init</a>
105
 
<li ><a href ="NSString.html#method-45">-initWithCString:</a>
106
 
<li ><a href ="NSString.html#method-46">-initWithCString:</a>
107
 
<li ><a href ="NSString.html#method-47">-initWithCStringNoCopy:length:freeWhenDone:</a>
108
 
<li ><a href ="NSString.html#method-42">-initWithCharacters:</a>
109
 
<li ><a href ="NSString.html#method-43">-initWithCharactersNoCopy:length:freeWhenDone:</a>
110
 
<li ><a href ="NSString.html#method-44">-initWithContentsOfFile:</a>
111
 
<li ><a href ="NSString.html#method-48">-initWithData:encoding:</a>
112
 
<li ><a href ="NSString.html#method-49">-initWithFormat:</a>
113
 
<li ><a href ="NSString.html#method-52">-initWithFormat:arguments:</a>
114
 
<li ><a href ="NSString.html#method-50">-initWithFormat:arguments:</a>
115
 
<li ><a href ="NSString.html#method-51">-initWithFormat:locale:</a>
116
 
<li ><a href ="NSString.html#method-53">-initWithFormat:locale:arguments:</a>
117
 
<li ><a href ="NSString.html#method-54">-initWithString:</a>
118
 
<li ><a href ="NSString.html#method-55">-intValue</a>
119
 
<li ><a href ="NSString.html#method-56">-isAbsolutePath</a>
120
 
<li ><a href ="NSString.html#method-57">-isEqualToString:</a>
121
 
<li ><a href ="NSString.html#method-58">-lastPathComponent</a>
122
 
<li ><a href ="NSString.html#method-59">-length</a>
123
 
<li ><a href ="NSString.html#method-61">-lossyCString</a>
124
 
<li ><a href ="NSString.html#method-62">-lowercaseString</a>
125
 
<li ><a href ="NSString.html#method-63">-pathComponents</a>
126
 
<li ><a href ="NSString.html#method-64">-pathExtension</a>
127
 
<li ><a href ="NSString.html#method-65">-propertyList</a>
128
 
<li ><a href ="NSString.html#method-66">-propertyListFromStringsFileFormat</a>
129
 
<li ><a href ="NSString.html#method-67">-rangeOfCharacterFromSet:</a>
130
 
<li ><a href ="NSString.html#method-68">-rangeOfCharacterFromSet:options:</a>
131
 
<li ><a href ="NSString.html#method-69">-rangeOfCharacterFromSet:options:range:</a>
132
 
<li ><a href ="NSString.html#method-70">-rangeOfComposedCharacterSequenceAtIndex:</a>
133
 
<li ><a href ="NSString.html#method-71">-rangeOfString:</a>
134
 
<li ><a href ="NSString.html#method-72">-rangeOfString:options:</a>
135
 
<li ><a href ="NSString.html#method-73">-rangeOfString:options:range:</a>
136
 
<li ><a href ="NSString.html#method-74">-smallestEncoding</a>
137
 
<li ><a href ="NSString.html#method-75">-stringByAbbreviatingWithTildeInPath</a>
138
 
<li ><a href ="NSString.html#method-76">-stringByAppendingFormat:</a>
139
 
<li ><a href ="NSString.html#method-77">-stringByAppendingPathComponent:</a>
140
 
<li ><a href ="NSString.html#method-78">-stringByAppendingPathExtension:</a>
141
 
<li ><a href ="NSString.html#method-79">-stringByAppendingString:</a>
142
 
<li ><a href ="NSString.html#method-80">-stringByDeletingLastPathComponent</a>
143
 
<li ><a href ="NSString.html#method-81">-stringByDeletingPathExtension</a>
144
 
<li ><a href ="NSString.html#method-82">-stringByExpandingTildeInPath</a>
145
 
<li ><a href ="NSString.html#method-83">-stringByReplacingString:withString:</a>
146
 
<li ><a href ="NSString.html#method-84">-stringsByAppendingPaths:</a>
147
 
<li ><a href ="NSString.html#method-85">-substringFromIndex:</a>
148
 
<li ><a href ="NSString.html#method-86">-substringToIndex:</a>
149
 
<li ><a href ="NSString.html#method-87">-substringWithRange:</a>
150
 
<li ><a href ="NSString.html#method-88">-uppercaseString</a>
151
 
<li ><a href ="NSString.html#method-89">-writeToFile:atomically:</a>
152
 
</ul>
153
 
<hr><h2>Class Methods </h2>
154
 
<h3><a name ="method-0">availableStringEncodings</a></h3>
155
 
+ (const NSStringEncoding*) <b>availableStringEncodings</b>;<br>
156
 
 
157
 
            <p>
158
 
 
159
 
              Returns an array of all available string encodings,
160
 
              terminated by a null value.
161
 
            </p>
162
 
 
163
 
          
164
 
 <hr>
165
 
<h3><a name ="method-1">defaultCStringEncoding</a></h3>
166
 
+ (NSStringEncoding) <b>defaultCStringEncoding</b>;<br>
167
 
 
168
 
            <p>
169
 
 
170
 
              Returns the encoding used for any method accepting a C string.
171
 
              This value is determined automatically from the programs
172
 
              environment and cannot be changed programmatically.
173
 
            </p>
174
 
 
175
 
            <p>
176
 
 
177
 
              You should <em>NOT</em> override this method in an attempt to
178
 
              change the encoding being used.
179
 
            </p>
180
 
 
181
 
            <p>
182
 
 
183
 
              In GNUstep, this encoding is determined by the initial value
184
 
              of the <code>GNUSTEP_STRING_ENCODING</code> environment
185
 
              variable.  If this is not defined,
186
 
              <code>NSISOLatin1StringEncoding</code> is assumed.
187
 
            </p>
188
 
 
189
 
            <p>
190
 
 
191
 
              The default C string encoding must be a characterset containing
192
 
              7 or 8 bit characters, and where the characters are a superset
193
 
              of the 7-bit ASCII characterset.  In particular, this means
194
 
              that NSUTF8StringEncoding and NSUnicodeStringEncoding are not
195
 
              permissable.
196
 
            </p>
197
 
 
198
 
          
199
 
 <hr>
200
 
<h3><a name ="method-2">localizedNameOfStringEncoding:</a></h3>
201
 
+ (NSString*) <b>localizedNameOfStringEncoding:</b> (NSStringEncoding)encoding;<br>
202
 
 
203
 
            <p>
204
 
 
205
 
              Returns the localized name of the encoding specified
206
 
              by <var>encoding</var>.
207
 
            </p>
208
 
 
209
 
          
210
 
 <hr>
211
 
<h3><a name ="method-3">localizedStringWithFormat:</a></h3>
212
 
+ (NSString*) <b>localizedStringWithFormat:</b> (NSString*)format,;<br>
213
 
 
214
 
          
215
 
 <hr>
216
 
<h3><a name ="method-4">pathWithComponents:</a></h3>
217
 
+ (NSString*) <b>pathWithComponents:</b> (NSArray*)components;<br>
218
 
 
219
 
          
220
 
 <hr>
221
 
<h3><a name ="method-5">string</a></h3>
222
 
+ (id) <b>string</b>;<br>
223
 
 
224
 
          
225
 
 <hr>
226
 
<h3><a name ="method-6">stringWithCharacters:length:</a></h3>
227
 
+ (id) <b>stringWithCharacters:</b> (const unichar*)chars <b>length:</b> (unsigned int)length;<br>
228
 
 
229
 
          
230
 
 <hr>
231
 
<h3><a name ="method-7">stringWithContentsOfFile:</a></h3>
232
 
+ (id) <b>stringWithContentsOfFile:</b> (NSString*)path;<br>
233
 
 
234
 
          
235
 
 <hr>
236
 
<h3><a name ="method-8">stringWithCString:</a></h3>
237
 
+ (id) <b>stringWithCString:</b> (const char*)cString;<br>
238
 
 
239
 
          
240
 
 <hr>
241
 
<h3><a name ="method-9">stringWithCString:</a></h3>
242
 
+ (id) <b>stringWithCString:</b> (const char*)cString;<br>
243
 
 
244
 
          
245
 
 <hr>
246
 
<h3><a name ="method-10">stringWithFormat:</a></h3>
247
 
+ (id) <b>stringWithFormat:</b> (NSString*)format,;<br>
248
 
 
249
 
          
250
 
 <hr>
251
 
<h3><a name ="method-11">stringWithString:</a></h3>
252
 
+ (id) <b>stringWithString:</b> (NSString*)aString;<br>
253
 
 
254
 
          
255
 
 <hr>
256
 
<h3><a name ="method-37">getLineStart:end:contentsEnd:</a></h3>
257
 
+ (void) <b>getLineStart:</b> (unsigned int*)startIndex <b>end:</b> (unsigned int*)lineEndIndex <b>contentsEnd:</b> (unsigned int*)contentsEndIndex;<br>
258
 
 
259
 
          
260
 
 <hr>
261
 
<h3><a name ="method-60">lineRangeForRange:</a></h3>
262
 
+ (NSRange) <b>lineRangeForRange:</b> (NSRange)aRange;<br>
263
 
 
264
 
          
265
 
 <hr>
266
 
<hr><h2>Instances Methods </h2>
267
 
<h3><a name ="method-12">canBeConvertedToEncoding:</a></h3>
268
 
- (BOOL) <b>canBeConvertedToEncoding:</b> (NSStringEncoding)encoding;<br>
269
 
 
270
 
          
271
 
 <hr>
272
 
<h3><a name ="method-13">capitalizedString</a></h3>
273
 
- (NSString*) <b>capitalizedString</b>;<br>
274
 
 
275
 
          
276
 
 <hr>
277
 
<h3><a name ="method-14">caseInsensitiveCompare:</a></h3>
278
 
- (NSComparisonResult) <b>caseInsensitiveCompare:</b> (NSString*)aString;<br>
279
 
 
280
 
          
281
 
 <hr>
282
 
<h3><a name ="method-15">characterAtIndex:</a></h3>
283
 
- (unichar) <b>characterAtIndex:</b> (unsigned int)index;<br>
284
 
 
285
 
          
286
 
 <hr>
287
 
<h3><a name ="method-16">commonPrefixWithString:</a></h3>
288
 
- (NSString*) <b>commonPrefixWithString:</b> (NSString*)aString;<br>
289
 
 
290
 
          
291
 
 <hr>
292
 
<h3><a name ="method-17">compare:</a></h3>
293
 
- (NSComparisonResult) <b>compare:</b> (NSString*)aString;<br>
294
 
 
295
 
          
296
 
 <hr>
297
 
<h3><a name ="method-18">compare:</a></h3>
298
 
- (NSComparisonResult) <b>compare:</b> (NSString*)aString;<br>
299
 
 
300
 
          
301
 
 <hr>
302
 
<h3><a name ="method-19">compare:options:range:</a></h3>
303
 
- (NSComparisonResult) <b>compare:</b> (NSString*)aString <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange;<br>
304
 
 
305
 
          
306
 
 <hr>
307
 
<h3><a name ="method-20">completePathIntoString:caseSensitive:matchesIntoArray:</a></h3>
308
 
- (unsigned int) <b>completePathIntoString:</b> (NSString**)outputName <b>caseSensitive:</b> (BOOL)flag <b>matchesIntoArray:</b> (NSArray**)outputArray;<br>
309
 
 
310
 
          
311
 
 <hr>
312
 
<h3><a name ="method-21">componentsSeparatedByString:</a></h3>
313
 
- (NSArray*) <b>componentsSeparatedByString:</b> (NSString*)separator;<br>
314
 
 
315
 
          
316
 
 <hr>
317
 
<h3><a name ="method-22">cString</a></h3>
318
 
- (const char*) <b>cString</b>;<br>
319
 
 
320
 
            Returns a pointer to a nul terminated string of 8-bit
321
 
            characters in the default encoding.  The memory pointed
322
 
            to is not owned by the caller, so the caller must copy
323
 
            its contents to keep it.
324
 
          
325
 
 <hr>
326
 
<h3><a name ="method-23">cStringLength</a></h3>
327
 
- (unsigned int) <b>cStringLength</b>;<br>
328
 
 
329
 
          
330
 
 <hr>
331
 
<h3><a name ="method-24">dataUsingEncoding:</a></h3>
332
 
- (NSData*) <b>dataUsingEncoding:</b> (NSStringEncoding)encoding;<br>
333
 
 
334
 
          
335
 
 <hr>
336
 
<h3><a name ="method-25">dataUsingEncoding:allowLossyConversion:</a></h3>
337
 
- (NSData*) <b>dataUsingEncoding:</b> (NSStringEncoding)encoding <b>allowLossyConversion:</b> (BOOL)flag;<br>
338
 
 
339
 
          
340
 
 <hr>
341
 
<h3><a name ="method-26">description</a></h3>
342
 
- (NSString*) <b>description</b>;<br>
343
 
 
344
 
          
345
 
 <hr>
346
 
<h3><a name ="method-27">doubleValue</a></h3>
347
 
- (double) <b>doubleValue</b>;<br>
348
 
 
349
 
          
350
 
 <hr>
351
 
<h3><a name ="method-28">fastestEncoding</a></h3>
352
 
- (NSStringEncoding) <b>fastestEncoding</b>;<br>
353
 
 
354
 
          
355
 
 <hr>
356
 
<h3><a name ="method-29">fileSystemRepresentation</a></h3>
357
 
- (const char*) <b>fileSystemRepresentation</b>;<br>
358
 
 
359
 
          
360
 
 <hr>
361
 
<h3><a name ="method-30">floatValue</a></h3>
362
 
- (float) <b>floatValue</b>;<br>
363
 
 
364
 
          
365
 
 <hr>
366
 
<h3><a name ="method-31">getCharacters:</a></h3>
367
 
- (void) <b>getCharacters:</b> (unichar*)buffer;<br>
368
 
 
369
 
          
370
 
 <hr>
371
 
<h3><a name ="method-32">getCharacters:</a></h3>
372
 
- (void) <b>getCharacters:</b> (unichar*)buffer;<br>
373
 
 
374
 
          
375
 
 <hr>
376
 
<h3><a name ="method-33">getCString:</a></h3>
377
 
- (void) <b>getCString:</b> (char*)buffer;<br>
378
 
 
379
 
          
380
 
 <hr>
381
 
<h3><a name ="method-34">getCString:maxLength:</a></h3>
382
 
- (void) <b>getCString:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength;<br>
383
 
 
384
 
          
385
 
 <hr>
386
 
<h3><a name ="method-35">getCString:maxLength:range:remainingRange:</a></h3>
387
 
- (void) <b>getCString:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength <b>range:</b> (NSRange)aRange <b>remainingRange:</b> (NSRange*)leftoverRange;<br>
388
 
 
389
 
          
390
 
 <hr>
391
 
<h3><a name ="method-36">getFileSystemRepresentation:maxLength:</a></h3>
392
 
- (BOOL) <b>getFileSystemRepresentation:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength;<br>
393
 
 
394
 
          
395
 
 <hr>
396
 
<h3><a name ="method-38">hash</a></h3>
397
 
- (unsigned int) <b>hash</b>;<br>
398
 
 
399
 
          
400
 
 <hr>
401
 
<h3><a name ="method-39">hasPrefix:</a></h3>
402
 
- (BOOL) <b>hasPrefix:</b> (NSString*)aString;<br>
403
 
 
404
 
          
405
 
 <hr>
406
 
<h3><a name ="method-40">hasSuffix:</a></h3>
407
 
- (BOOL) <b>hasSuffix:</b> (NSString*)aString;<br>
408
 
 
409
 
          
410
 
 <hr>
411
 
<h3><a name ="method-41">init</a></h3>
412
 
- (id) <b>init</b>;<br>
413
 
 
414
 
          
415
 
 <hr>
416
 
<h3><a name ="method-42">initWithCharacters:</a></h3>
417
 
- (id) <b>initWithCharacters:</b> (const unichar*)characters;<br>
418
 
 
419
 
          
420
 
 <hr>
421
 
<h3><a name ="method-43">initWithCharactersNoCopy:length:freeWhenDone:</a></h3>
422
 
<b>This is the designated initialiser </b><br>
423
 
- (id) <b>initWithCharactersNoCopy:</b> (unichar*)characters <b>length:</b> (unsigned int)length <b>freeWhenDone:</b> (BOOL)flag;<br>
424
 
 
425
 
            This is the most basic initialiser for unicode strings.
426
 
            In the GNUstep implementation, your subclasses may override
427
 
            this initialiser in order to have all others function.
428
 
          
429
 
 <hr>
430
 
<h3><a name ="method-44">initWithContentsOfFile:</a></h3>
431
 
- (id) <b>initWithContentsOfFile:</b> (NSString*)path;<br>
432
 
 
433
 
          
434
 
 <hr>
435
 
<h3><a name ="method-45">initWithCString:</a></h3>
436
 
- (id) <b>initWithCString:</b> (const char*)cString;<br>
437
 
 
438
 
          
439
 
 <hr>
440
 
<h3><a name ="method-46">initWithCString:</a></h3>
441
 
- (id) <b>initWithCString:</b> (const char*)cString;<br>
442
 
 
443
 
          
444
 
 <hr>
445
 
<h3><a name ="method-47">initWithCStringNoCopy:length:freeWhenDone:</a></h3>
446
 
- (id) <b>initWithCStringNoCopy:</b> (char*)cString <b>length:</b> (unsigned int)length <b>freeWhenDone:</b> (BOOL)flag;<br>
447
 
 
448
 
          
449
 
 <hr>
450
 
<h3><a name ="method-48">initWithData:encoding:</a></h3>
451
 
- (id) <b>initWithData:</b> (NSData*)data <b>encoding:</b> (NSStringEncoding)encoding;<br>
452
 
 
453
 
          
454
 
 <hr>
455
 
<h3><a name ="method-49">initWithFormat:</a></h3>
456
 
- (id) <b>initWithFormat:</b> (NSString*)format, ...;<br>
457
 
 
458
 
            Invokes initWithFormat:locale:arguments with a nil locale.
459
 
          
460
 
 <hr>
461
 
<h3><a name ="method-50">initWithFormat:arguments:</a></h3>
462
 
- (id) <b>initWithFormat:</b> (NSString*)format <b>arguments:</b> (va_list)argList;<br>
463
 
 
464
 
            Invokes initWithFormat:locale:arguments with a nil locale.
465
 
          
466
 
 <hr>
467
 
<h3><a name ="method-51">initWithFormat:locale:</a></h3>
468
 
- (id) <b>initWithFormat:</b> (NSString*)format <b>locale:</b> (NSDictionary*)dictionary, ...;<br>
469
 
 
470
 
            Initialises the string using the specified format and local
471
 
            to format the following arguments.
472
 
          
473
 
 <hr>
474
 
<h3><a name ="method-52">initWithFormat:arguments:</a></h3>
475
 
- (id) <b>initWithFormat:</b> (NSString*)format <b>arguments:</b> (va_list)argList;<br>
476
 
 
477
 
            Invokes initWithFormat:locale:,... with a nil locale.
478
 
          
479
 
 <hr>
480
 
<h3><a name ="method-53">initWithFormat:locale:arguments:</a></h3>
481
 
- (id) <b>initWithFormat:</b> (NSString*)format <b>locale:</b> (NSDictionary*)dictionary <b>arguments:</b> (va_list)argList;<br>
482
 
 
483
 
            Initialises the string using the specified format and local
484
 
            to format the following arguments.
485
 
          
486
 
 <hr>
487
 
<h3><a name ="method-54">initWithString:</a></h3>
488
 
- (id) <b>initWithString:</b> (NSString*)aString;<br>
489
 
 
490
 
          
491
 
 <hr>
492
 
<h3><a name ="method-55">intValue</a></h3>
493
 
- (int) <b>intValue</b>;<br>
494
 
 
495
 
          
496
 
 <hr>
497
 
<h3><a name ="method-56">isAbsolutePath</a></h3>
498
 
- (BOOL) <b>isAbsolutePath</b>;<br>
499
 
 
500
 
          
501
 
 <hr>
502
 
<h3><a name ="method-57">isEqualToString:</a></h3>
503
 
- (BOOL) <b>isEqualToString:</b> (NSString*)aString;<br>
504
 
 
505
 
          
506
 
 <hr>
507
 
<h3><a name ="method-58">lastPathComponent</a></h3>
508
 
- (NSString*) <b>lastPathComponent</b>;<br>
509
 
 
510
 
          
511
 
 <hr>
512
 
<h3><a name ="method-59">length</a></h3>
513
 
- (unsigned int) <b>length</b>;<br>
514
 
 
515
 
          
516
 
 <hr>
517
 
<h3><a name ="method-61">lossyCString</a></h3>
518
 
- (const char*) <b>lossyCString</b>;<br>
519
 
 
520
 
          
521
 
 <hr>
522
 
<h3><a name ="method-62">lowercaseString</a></h3>
523
 
- (NSString*) <b>lowercaseString</b>;<br>
524
 
 
525
 
            Returns a copy of the receiver with all characters converted
526
 
            to lowercase.
527
 
          
528
 
 <hr>
529
 
<h3><a name ="method-63">pathComponents</a></h3>
530
 
- (NSArray*) <b>pathComponents</b>;<br>
531
 
 
532
 
          
533
 
 <hr>
534
 
<h3><a name ="method-64">pathExtension</a></h3>
535
 
- (NSString*) <b>pathExtension</b>;<br>
536
 
 
537
 
          
538
 
 <hr>
539
 
<h3><a name ="method-65">propertyList</a></h3>
540
 
- (id) <b>propertyList</b>;<br>
541
 
 
542
 
          
543
 
 <hr>
544
 
<h3><a name ="method-66">propertyListFromStringsFileFormat</a></h3>
545
 
- (NSDictionary*) <b>propertyListFromStringsFileFormat</b>;<br>
546
 
 
547
 
          
548
 
 <hr>
549
 
<h3><a name ="method-67">rangeOfCharacterFromSet:</a></h3>
550
 
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet;<br>
551
 
 
552
 
          
553
 
 <hr>
554
 
<h3><a name ="method-68">rangeOfCharacterFromSet:options:</a></h3>
555
 
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet <b>options:</b> (unsigned int)mask;<br>
556
 
 
557
 
          
558
 
 <hr>
559
 
<h3><a name ="method-69">rangeOfCharacterFromSet:options:range:</a></h3>
560
 
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange;<br>
561
 
 
562
 
          
563
 
 <hr>
564
 
<h3><a name ="method-70">rangeOfComposedCharacterSequenceAtIndex:</a></h3>
565
 
- (NSRange) <b>rangeOfComposedCharacterSequenceAtIndex:</b> (unsigned int)anIndex;<br>
566
 
 
567
 
          
568
 
 <hr>
569
 
<h3><a name ="method-71">rangeOfString:</a></h3>
570
 
- (NSRange) <b>rangeOfString:</b> (NSString*)aString;<br>
571
 
 
572
 
            Invokes <em>rangeOfString:options:</em> with the options mask
573
 
            set to zero.
574
 
          
575
 
 <hr>
576
 
<h3><a name ="method-72">rangeOfString:options:</a></h3>
577
 
- (NSRange) <b>rangeOfString:</b> (NSString*)aString <b>options:</b> (unsigned int)mask;<br>
578
 
 
579
 
            Invokes <em>rangeOfString:options:range</em> with the range set
580
 
            set to the range of the whole of the reciever.
581
 
          
582
 
 <hr>
583
 
<h3><a name ="method-73">rangeOfString:options:range:</a></h3>
584
 
- (NSRange) <b>rangeOfString:</b> (NSString*)subString <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange;<br>
585
 
 
586
 
            Returns the range giving the location and length of the first
587
 
            occurrence of <em>subString</em> within <em>aRange</em>.
588
 
            <br>
589
 
            If <em>subString</em> does not exist in the receiver (an empty
590
 
            string is <em>never</em> considered to exist in the receiver),
591
 
            the length of the returned range is zero.
592
 
            <br>
593
 
            If <em>substring</em> is nil, an exception is raised.
594
 
            <br>
595
 
            If any part of <em>aRange</em> lies outside the range of the
596
 
            receiver, an exception is raised.
597
 
            <br>
598
 
            The optionsm mask may contain the following options -
599
 
            <ul>
600
 
<li >NSCaseInsensitiveSearch
601
 
<li >NSLiteralSearch
602
 
<li >NSBackwardsSearch
603
 
<li >NSAnchoredSearch
604
 
</ul>
605
 
 
606
 
          
607
 
 <hr>
608
 
<h3><a name ="method-74">smallestEncoding</a></h3>
609
 
- (NSStringEncoding) <b>smallestEncoding</b>;<br>
610
 
 
611
 
          
612
 
 <hr>
613
 
<h3><a name ="method-75">stringByAbbreviatingWithTildeInPath</a></h3>
614
 
- (NSString*) <b>stringByAbbreviatingWithTildeInPath</b>;<br>
615
 
 
616
 
          
617
 
 <hr>
618
 
<h3><a name ="method-76">stringByAppendingFormat:</a></h3>
619
 
- (NSString*) <b>stringByAppendingFormat:</b> (NSString*)format,;<br>
620
 
 
621
 
          
622
 
 <hr>
623
 
<h3><a name ="method-77">stringByAppendingPathComponent:</a></h3>
624
 
- (NSString*) <b>stringByAppendingPathComponent:</b> (NSString*)aString;<br>
625
 
 
626
 
          
627
 
 <hr>
628
 
<h3><a name ="method-78">stringByAppendingPathExtension:</a></h3>
629
 
- (NSString*) <b>stringByAppendingPathExtension:</b> (NSString*)string;<br>
630
 
 
631
 
          
632
 
 <hr>
633
 
<h3><a name ="method-79">stringByAppendingString:</a></h3>
634
 
- (NSString*) <b>stringByAppendingString:</b> (NSString*)aString;<br>
635
 
 
636
 
          
637
 
 <hr>
638
 
<h3><a name ="method-80">stringByDeletingLastPathComponent</a></h3>
639
 
- (NSString*) <b>stringByDeletingLastPathComponent</b>;<br>
640
 
 
641
 
          
642
 
 <hr>
643
 
<h3><a name ="method-81">stringByDeletingPathExtension</a></h3>
644
 
- (NSString*) <b>stringByDeletingPathExtension</b>;<br>
645
 
 
646
 
          
647
 
 <hr>
648
 
<h3><a name ="method-82">stringByExpandingTildeInPath</a></h3>
649
 
- (NSString*) <b>stringByExpandingTildeInPath</b>;<br>
650
 
 
651
 
          
652
 
 <hr>
653
 
<h3><a name ="method-83">stringByReplacingString:withString:</a></h3>
654
 
- (NSString*) <b>stringByReplacingString:</b> (NSString*)aString <b>withString:</b> (NSString*)replacement;<br>
655
 
Standards:  GNUstep NotMacOS-X NotOpenStep<br>
656
 
 
657
 
            Returns a string in which any (and all) occurrances of
658
 
            <em>aString</em> in the receiver have been replaced by
659
 
            <em>replacement</em>.  Returns the receiver if <em>aString</em>
660
 
            does not occur within the receiver.  NB. an empty string is
661
 
            not considered to exist within the receiver.
662
 
          
663
 
 <hr>
664
 
<h3><a name ="method-84">stringsByAppendingPaths:</a></h3>
665
 
- (NSArray*) <b>stringsByAppendingPaths:</b> (NSArray*)paths;<br>
666
 
 
667
 
          
668
 
 <hr>
669
 
<h3><a name ="method-85">substringFromIndex:</a></h3>
670
 
- (NSString*) <b>substringFromIndex:</b> (unsigned int)anIndex;<br>
671
 
 
672
 
          
673
 
 <hr>
674
 
<h3><a name ="method-86">substringToIndex:</a></h3>
675
 
- (NSString*) <b>substringToIndex:</b> (unsigned int)anIndex;<br>
676
 
 
677
 
          
678
 
 <hr>
679
 
<h3><a name ="method-87">substringWithRange:</a></h3>
680
 
- (NSString*) <b>substringWithRange:</b> (NSRange)aRange;<br>
681
 
 
682
 
          
683
 
 <hr>
684
 
<h3><a name ="method-88">uppercaseString</a></h3>
685
 
- (NSString*) <b>uppercaseString</b>;<br>
686
 
 
687
 
            Returns a copy of the receiver with all characters converted
688
 
            to uppercase.
689
 
          
690
 
 <hr>
691
 
<h3><a name ="method-89">writeToFile:atomically:</a></h3>
692
 
- (BOOL) <b>writeToFile:</b> (NSString*)path <b>atomically:</b> (BOOL)flag;<br>
693
 
 
694
 
          
695
 
 <hr>
696
 
</body>
697
 
 
698
 
 </html>