libs-base/Documentation/gsdoc/NSString.html

559 lines
18 KiB
HTML
Raw Normal View History

<html><head>
<title>NSString</title>
</head>
<body>
<a href="NSSet.html">[Previous]</a>
<a href="Base.html">[Up]</a>
<a href="NSTask.html">[Next]</a>
<h1>NSString</h1>
<h3>Authors</h3>
<dl>
<dt><a href="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
<dd>
</dl>
<p>Version: 0.1</p>
<p>Date: 28 February, 2000</p>
<h2><a name="cont-0">NSString</a></h2>
<h2><a name="NSString">NSString</a></h2>
<p><b>Declared in:</b> Foundation/NSString.h</p>
<p><b>Inherits from:</b> NSObject</p>
<p><b>Conforms to:</b> NSCoding
</p>
<hr>
<ul>
<li><a href="NSString.html#method-0">+availableStringEncodings</a>
<li><a href="NSString.html#method-1">+defaultCStringEncoding</a>
<li><a href="NSString.html#method-37">+getLineStart:end:contentsEnd:</a>
<li><a href="NSString.html#method-59">+lineRangeForRange:</a>
<li><a href="NSString.html#method-2">+localizedNameOfStringEncoding:</a>
<li><a href="NSString.html#method-3">+localizedStringWithFormat:</a>
<li><a href="NSString.html#method-4">+pathWithComponents:</a>
<li><a href="NSString.html#method-5">+string</a>
<li><a href="NSString.html#method-8">+stringWithCString:</a>
<li><a href="NSString.html#method-9">+stringWithCString:</a>
<li><a href="NSString.html#method-6">+stringWithCharacters:length:</a>
<li><a href="NSString.html#method-7">+stringWithContentsOfFile:</a>
<li><a href="NSString.html#method-10">+stringWithFormat:</a>
<li><a href="NSString.html#method-11">+stringWithString:</a>
<li><a href="NSString.html#method-22">-cString</a>
<li><a href="NSString.html#method-23">-cStringLength</a>
<li><a href="NSString.html#method-12">-canBeConvertedToEncoding:</a>
<li><a href="NSString.html#method-13">-capitalizedString</a>
<li><a href="NSString.html#method-14">-caseInsensitiveCompare:</a>
<li><a href="NSString.html#method-15">-characterAtIndex:</a>
<li><a href="NSString.html#method-16">-commonPrefixWithString:</a>
<li><a href="NSString.html#method-17">-compare:</a>
<li><a href="NSString.html#method-18">-compare:</a>
<li><a href="NSString.html#method-19">-compare:options:range:</a>
<li><a href="NSString.html#method-20">-completePathIntoString:caseSensitive:matchesIntoArray:</a>
<li><a href="NSString.html#method-21">-componentsSeparatedByString:</a>
<li><a href="NSString.html#method-24">-dataUsingEncoding:</a>
<li><a href="NSString.html#method-25">-dataUsingEncoding:allowLossyConversion:</a>
<li><a href="NSString.html#method-26">-description</a>
<li><a href="NSString.html#method-27">-doubleValue</a>
<li><a href="NSString.html#method-28">-fastestEncoding</a>
<li><a href="NSString.html#method-29">-fileSystemRepresentation</a>
<li><a href="NSString.html#method-30">-floatValue</a>
<li><a href="NSString.html#method-33">-getCString:</a>
<li><a href="NSString.html#method-34">-getCString:maxLength:</a>
<li><a href="NSString.html#method-35">-getCString:maxLength:range:remainingRange:</a>
<li><a href="NSString.html#method-32">-getCharacters:</a>
<li><a href="NSString.html#method-31">-getCharacters:</a>
<li><a href="NSString.html#method-36">-getFileSystemRepresentation:maxLength:</a>
<li><a href="NSString.html#method-39">-hasPrefix:</a>
<li><a href="NSString.html#method-40">-hasSuffix:</a>
<li><a href="NSString.html#method-38">-hash</a>
<li><a href="NSString.html#method-41">-init</a>
<li><a href="NSString.html#method-46">-initWithCString:</a>
<li><a href="NSString.html#method-45">-initWithCString:</a>
<li><a href="NSString.html#method-47">-initWithCStringNoCopy:length:freeWhenDone:</a>
<li><a href="NSString.html#method-42">-initWithCharacters:</a>
<li><a href="NSString.html#method-43">-initWithCharactersNoCopy:length:freeWhenDone:</a>
<li><a href="NSString.html#method-44">-initWithContentsOfFile:</a>
<li><a href="NSString.html#method-48">-initWithData:encoding:</a>
<li><a href="NSString.html#method-49">-initWithFormat:</a>
<li><a href="NSString.html#method-51">-initWithFormat:</a>
<li><a href="NSString.html#method-50">-initWithFormat:arguments:</a>
<li><a href="NSString.html#method-52">-initWithFormat:locale:arguments:</a>
<li><a href="NSString.html#method-53">-initWithString:</a>
<li><a href="NSString.html#method-54">-intValue</a>
<li><a href="NSString.html#method-55">-isAbsolutePath</a>
<li><a href="NSString.html#method-56">-isEqualToString:</a>
<li><a href="NSString.html#method-57">-lastPathComponent</a>
<li><a href="NSString.html#method-58">-length</a>
<li><a href="NSString.html#method-60">-lossyCString</a>
<li><a href="NSString.html#method-61">-lowercaseString</a>
<li><a href="NSString.html#method-62">-pathComponents</a>
<li><a href="NSString.html#method-63">-pathExtension</a>
<li><a href="NSString.html#method-64">-propertyList</a>
<li><a href="NSString.html#method-65">-propertyListFromStringsFileFormat</a>
<li><a href="NSString.html#method-66">-rangeOfCharacterFromSet:</a>
<li><a href="NSString.html#method-67">-rangeOfCharacterFromSet:options:</a>
<li><a href="NSString.html#method-68">-rangeOfCharacterFromSet:options:range:</a>
<li><a href="NSString.html#method-69">-rangeOfComposedCharacterSequenceAtIndex:</a>
<li><a href="NSString.html#method-70">-rangeOfString:</a>
<li><a href="NSString.html#method-71">-rangeOfString:</a>
<li><a href="NSString.html#method-72">-rangeOfString:options:range:</a>
<li><a href="NSString.html#method-73">-smallestEncoding</a>
<li><a href="NSString.html#method-74">-stringByAbbreviatingWithTildeInPath</a>
<li><a href="NSString.html#method-75">-stringByAppendingFormat:</a>
<li><a href="NSString.html#method-76">-stringByAppendingPathComponent:</a>
<li><a href="NSString.html#method-77">-stringByAppendingPathExtension:</a>
<li><a href="NSString.html#method-78">-stringByAppendingString:</a>
<li><a href="NSString.html#method-79">-stringByDeletingLastPathComponent</a>
<li><a href="NSString.html#method-80">-stringByDeletingPathExtension</a>
<li><a href="NSString.html#method-81">-stringByExpandingTildeInPath</a>
<li><a href="NSString.html#method-82">-stringsByAppendingPaths:</a>
<li><a href="NSString.html#method-83">-substringFromIndex:</a>
<li><a href="NSString.html#method-84">-substringToIndex:</a>
<li><a href="NSString.html#method-85">-substringWithRange:</a>
<li><a href="NSString.html#method-86">-uppercaseString</a>
<li><a href="NSString.html#method-87">-writeToFile:atomically:</a>
</ul>
<hr>
<h2><a name="method-0">availableStringEncodings</a></h2>
+ (const NSStringEncoding*) <b>availableStringEncodings</b><br>
<hr>
<h2><a name="method-1">defaultCStringEncoding</a></h2>
+ (NSStringEncoding) <b>defaultCStringEncoding</b><br>
<hr>
<h2><a name="method-2">localizedNameOfStringEncoding:</a></h2>
+ (NSString*) <b>localizedNameOfStringEncoding:</b> (NSStringEncoding)encoding<br>
<hr>
<h2><a name="method-3">localizedStringWithFormat:</a></h2>
+ (NSString*) <b>localizedStringWithFormat:</b> (NSString*)format,<br>
<hr>
<h2><a name="method-4">pathWithComponents:</a></h2>
+ (NSString*) <b>pathWithComponents:</b> (NSArray*)components<br>
<hr>
<h2><a name="method-5">string</a></h2>
+ (id) <b>string</b><br>
<hr>
<h2><a name="method-6">stringWithCharacters:length:</a></h2>
+ (id) <b>stringWithCharacters:</b> (const unichar*)chars <b>length:</b> (unsigned int)length<br>
<hr>
<h2><a name="method-7">stringWithContentsOfFile:</a></h2>
+ (id) <b>stringWithContentsOfFile:</b> (NSString*)path<br>
<hr>
<h2><a name="method-8">stringWithCString:</a></h2>
+ (id) <b>stringWithCString:</b> (const char*)cString<br>
<hr>
<h2><a name="method-9">stringWithCString:</a></h2>
+ (id) <b>stringWithCString:</b> (const char*)cString<br>
<hr>
<h2><a name="method-10">stringWithFormat:</a></h2>
+ (id) <b>stringWithFormat:</b> (NSString*)format,<br>
<hr>
<h2><a name="method-11">stringWithString:</a></h2>
+ (id) <b>stringWithString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-12">canBeConvertedToEncoding:</a></h2>
- (BOOL) <b>canBeConvertedToEncoding:</b> (NSStringEncoding)encoding<br>
<hr>
<h2><a name="method-13">capitalizedString</a></h2>
- (NSString*) <b>capitalizedString</b><br>
<hr>
<h2><a name="method-14">caseInsensitiveCompare:</a></h2>
- (NSComparisonResult) <b>caseInsensitiveCompare:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-15">characterAtIndex:</a></h2>
- (unichar) <b>characterAtIndex:</b> (unsigned int)index<br>
<hr>
<h2><a name="method-16">commonPrefixWithString:</a></h2>
- (NSString*) <b>commonPrefixWithString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-17">compare:</a></h2>
- (NSComparisonResult) <b>compare:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-18">compare:</a></h2>
- (NSComparisonResult) <b>compare:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-19">compare:options:range:</a></h2>
- (NSComparisonResult) <b>compare:</b> (NSString*)aString <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange<br>
<hr>
<h2><a name="method-20">completePathIntoString:caseSensitive:matchesIntoArray:</a></h2>
- (unsigned int) <b>completePathIntoString:</b> (NSString**)outputName <b>caseSensitive:</b> (BOOL)flag <b>matchesIntoArray:</b> (NSArray**)outputArray<br>
<hr>
<h2><a name="method-21">componentsSeparatedByString:</a></h2>
- (NSArray*) <b>componentsSeparatedByString:</b> (NSString*)separator<br>
<hr>
<h2><a name="method-22">cString</a></h2>
- (const char*) <b>cString</b><br>
<hr>
<h2><a name="method-23">cStringLength</a></h2>
- (unsigned int) <b>cStringLength</b><br>
<hr>
<h2><a name="method-24">dataUsingEncoding:</a></h2>
- (NSData*) <b>dataUsingEncoding:</b> (NSStringEncoding)encoding<br>
<hr>
<h2><a name="method-25">dataUsingEncoding:allowLossyConversion:</a></h2>
- (NSData*) <b>dataUsingEncoding:</b> (NSStringEncoding)encoding <b>allowLossyConversion:</b> (BOOL)flag<br>
<hr>
<h2><a name="method-26">description</a></h2>
- (NSString*) <b>description</b><br>
<hr>
<h2><a name="method-27">doubleValue</a></h2>
- (double) <b>doubleValue</b><br>
<hr>
<h2><a name="method-28">fastestEncoding</a></h2>
- (NSStringEncoding) <b>fastestEncoding</b><br>
<hr>
<h2><a name="method-29">fileSystemRepresentation</a></h2>
- (const char*) <b>fileSystemRepresentation</b><br>
<hr>
<h2><a name="method-30">floatValue</a></h2>
- (float) <b>floatValue</b><br>
<hr>
<h2><a name="method-31">getCharacters:</a></h2>
- (void) <b>getCharacters:</b> (unichar*)buffer<br>
<hr>
<h2><a name="method-32">getCharacters:</a></h2>
- (void) <b>getCharacters:</b> (unichar*)buffer<br>
<hr>
<h2><a name="method-33">getCString:</a></h2>
- (void) <b>getCString:</b> (char*)buffer<br>
<hr>
<h2><a name="method-34">getCString:maxLength:</a></h2>
- (void) <b>getCString:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength<br>
<hr>
<h2><a name="method-35">getCString:maxLength:range:remainingRange:</a></h2>
- (void) <b>getCString:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength <b>range:</b> (NSRange)aRange <b>remainingRange:</b> (NSRange*)leftoverRange<br>
<hr>
<h2><a name="method-36">getFileSystemRepresentation:maxLength:</a></h2>
- (BOOL) <b>getFileSystemRepresentation:</b> (char*)buffer <b>maxLength:</b> (unsigned int)maxLength<br>
<hr>
<h2><a name="method-37">getLineStart:end:contentsEnd:</a></h2>
+ (void) <b>getLineStart:</b> (unsigned int*)startIndex <b>end:</b> (unsigned int*)lineEndIndex <b>contentsEnd:</b> (unsigned int*)contentsEndIndex<br>
<hr>
<h2><a name="method-38">hash</a></h2>
- (unsigned int) <b>hash</b><br>
<hr>
<h2><a name="method-39">hasPrefix:</a></h2>
- (BOOL) <b>hasPrefix:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-40">hasSuffix:</a></h2>
- (BOOL) <b>hasSuffix:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-41">init</a></h2>
- (id) <b>init</b><br>
<hr>
<h2><a name="method-42">initWithCharacters:</a></h2>
- (id) <b>initWithCharacters:</b> (const unichar*)characters<br>
<hr>
<h2><a name="method-43">initWithCharactersNoCopy:length:freeWhenDone:</a></h2>
- (id) <b>initWithCharactersNoCopy:</b> (unichar*)characters <b>length:</b> (unsigned int)length <b>freeWhenDone:</b> (BOOL)flag<br>
<hr>
<h2><a name="method-44">initWithContentsOfFile:</a></h2>
- (id) <b>initWithContentsOfFile:</b> (NSString*)path<br>
<hr>
<h2><a name="method-45">initWithCString:</a></h2>
- (id) <b>initWithCString:</b> (const char*)cString<br>
<hr>
<h2><a name="method-46">initWithCString:</a></h2>
- (id) <b>initWithCString:</b> (const char*)cString<br>
<hr>
<h2><a name="method-47">initWithCStringNoCopy:length:freeWhenDone:</a></h2>
- (id) <b>initWithCStringNoCopy:</b> (char*)cString <b>length:</b> (unsigned int)length <b>freeWhenDone:</b> (BOOL)flag<br>
<hr>
<h2><a name="method-48">initWithData:encoding:</a></h2>
- (id) <b>initWithData:</b> (NSData*)data <b>encoding:</b> (NSStringEncoding)encoding<br>
<hr>
<h2><a name="method-49">initWithFormat:</a></h2>
- (id) <b>initWithFormat:</b> (NSString*)format,<br>
<hr>
<h2><a name="method-50">initWithFormat:arguments:</a></h2>
- (id) <b>initWithFormat:</b> (NSString*)format <b>arguments:</b> (va_list)argList<br>
<hr>
<h2><a name="method-51">initWithFormat:</a></h2>
- (id) <b>initWithFormat:</b> (NSString*)format<br>
<hr>
<h2><a name="method-52">initWithFormat:locale:arguments:</a></h2>
- (id) <b>initWithFormat:</b> (NSString*)format <b>locale:</b> (NSDictionary*)dictionary <b>arguments:</b> (va_list)argList<br>
<hr>
<h2><a name="method-53">initWithString:</a></h2>
- (id) <b>initWithString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-54">intValue</a></h2>
- (int) <b>intValue</b><br>
<hr>
<h2><a name="method-55">isAbsolutePath</a></h2>
- (BOOL) <b>isAbsolutePath</b><br>
<hr>
<h2><a name="method-56">isEqualToString:</a></h2>
- (BOOL) <b>isEqualToString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-57">lastPathComponent</a></h2>
- (NSString*) <b>lastPathComponent</b><br>
<hr>
<h2><a name="method-58">length</a></h2>
- (unsigned int) <b>length</b><br>
<hr>
<h2><a name="method-59">lineRangeForRange:</a></h2>
+ (NSRange) <b>lineRangeForRange:</b> (NSRange)aRange<br>
<hr>
<h2><a name="method-60">lossyCString</a></h2>
- (const char*) <b>lossyCString</b><br>
<hr>
<h2><a name="method-61">lowercaseString</a></h2>
- (NSString*) <b>lowercaseString</b><br>
<hr>
<h2><a name="method-62">pathComponents</a></h2>
- (NSArray*) <b>pathComponents</b><br>
<hr>
<h2><a name="method-63">pathExtension</a></h2>
- (NSString*) <b>pathExtension</b><br>
<hr>
<h2><a name="method-64">propertyList</a></h2>
- (id) <b>propertyList</b><br>
<hr>
<h2><a name="method-65">propertyListFromStringsFileFormat</a></h2>
- (NSDictionary*) <b>propertyListFromStringsFileFormat</b><br>
<hr>
<h2><a name="method-66">rangeOfCharacterFromSet:</a></h2>
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet<br>
<hr>
<h2><a name="method-67">rangeOfCharacterFromSet:options:</a></h2>
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet <b>options:</b> (unsigned int)mask<br>
<hr>
<h2><a name="method-68">rangeOfCharacterFromSet:options:range:</a></h2>
- (NSRange) <b>rangeOfCharacterFromSet:</b> (NSCharacterSet*)aSet <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange<br>
<hr>
<h2><a name="method-69">rangeOfComposedCharacterSequenceAtIndex:</a></h2>
- (NSRange) <b>rangeOfComposedCharacterSequenceAtIndex:</b> (unsigned int)anIndex<br>
<hr>
<h2><a name="method-70">rangeOfString:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-71">rangeOfString:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-72">rangeOfString:options:range:</a></h2>
- (NSRange) <b>rangeOfString:</b> (NSString*)subString <b>options:</b> (unsigned int)mask <b>range:</b> (NSRange)aRange<br>
<hr>
<h2><a name="method-73">smallestEncoding</a></h2>
- (NSStringEncoding) <b>smallestEncoding</b><br>
<hr>
<h2><a name="method-74">stringByAbbreviatingWithTildeInPath</a></h2>
- (NSString*) <b>stringByAbbreviatingWithTildeInPath</b><br>
<hr>
<h2><a name="method-75">stringByAppendingFormat:</a></h2>
- (NSString*) <b>stringByAppendingFormat:</b> (NSString*)format,<br>
<hr>
<h2><a name="method-76">stringByAppendingPathComponent:</a></h2>
- (NSString*) <b>stringByAppendingPathComponent:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-77">stringByAppendingPathExtension:</a></h2>
- (NSString*) <b>stringByAppendingPathExtension:</b> (NSString*)string<br>
<hr>
<h2><a name="method-78">stringByAppendingString:</a></h2>
- (NSString*) <b>stringByAppendingString:</b> (NSString*)aString<br>
<hr>
<h2><a name="method-79">stringByDeletingLastPathComponent</a></h2>
- (NSString*) <b>stringByDeletingLastPathComponent</b><br>
<hr>
<h2><a name="method-80">stringByDeletingPathExtension</a></h2>
- (NSString*) <b>stringByDeletingPathExtension</b><br>
<hr>
<h2><a name="method-81">stringByExpandingTildeInPath</a></h2>
- (NSString*) <b>stringByExpandingTildeInPath</b><br>
<hr>
<h2><a name="method-82">stringsByAppendingPaths:</a></h2>
- (NSArray*) <b>stringsByAppendingPaths:</b> (NSArray*)paths<br>
<hr>
<h2><a name="method-83">substringFromIndex:</a></h2>
- (NSString*) <b>substringFromIndex:</b> (unsigned int)anIndex<br>
<hr>
<h2><a name="method-84">substringToIndex:</a></h2>
- (NSString*) <b>substringToIndex:</b> (unsigned int)anIndex<br>
<hr>
<h2><a name="method-85">substringWithRange:</a></h2>
- (NSString*) <b>substringWithRange:</b> (NSRange)aRange<br>
<hr>
<h2><a name="method-86">uppercaseString</a></h2>
- (NSString*) <b>uppercaseString</b><br>
<hr>
<h2><a name="method-87">writeToFile:atomically:</a></h2>
- (BOOL) <b>writeToFile:</b> (NSString*)path <b>atomically:</b> (BOOL)flag<br>
<hr>
</body>
</html>