Changeset 227 for trunk/foundation/idl
- Timestamp:
- Feb 4, 2007, 10:51:43 PM (19 years ago)
- Location:
- trunk/foundation/idl
- Files:
-
- 2 edited
-
nomfilepath.idl (modified) (6 diffs)
-
nomstring.idl (modified) (7 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/foundation/idl/nomfilepath.idl
r225 r227 16 16 * The Initial Developer of the Original Code is 17 17 * netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>. 18 * Portions created by the Initial Developer are Copyright (C) 2005-200 618 * Portions created by the Initial Developer are Copyright (C) 2005-2007 19 19 * the Initial Developer. All Rights Reserved. 20 20 * … … 43 43 /** \class NOMPath 44 44 NOMPath is a specialized string class for dealing with file or directory paths. 45 As with NOMString the NOMPath class is always working on copies.46 45 */ 47 46 interface NOMPath : NOMString … … 58 57 starts with a separator and the current path ends with a separator the ending separator 59 58 will be removed before appending. 59 If no input path is given only a separator is appended if necessary. 60 60 61 61 \remark … … 64 64 65 65 \return 66 The method returns a newNOMPath instance after appending.66 The method returns the same NOMPath instance after appending. 67 67 68 68 \sa append(), appendCString() … … 72 72 /** 73 73 Append a separator to the path. If the path already has a separator at the end this method 74 does nothing other than returning a new path object. If the given path has zero length 75 a path object only holding a separator is returned. 74 does nothing other than returning the path object. If the given path has zero length 75 the path object only holding a separator is returned. 76 77 \remark The returned string object is not newly allocated. Be aware that the string data 78 held by the object may. 76 79 77 80 \return 78 This method always returns a new instance of a NOMPath owned by the caller.81 This method returns the NOMPath. This is not a copy. 79 82 80 83 \sa append(), appendPath() … … 86 89 87 90 \return 88 This method always returns a new instance of a NOMPath owned by the caller.91 This method returns the same instance of a NOMPath. 89 92 90 93 \sa appendSeparator() -
trunk/foundation/idl/nomstring.idl
r225 r227 45 45 Methods are provided for common tasks when dealing with strings like inserting or 46 46 appending strings. A string object never can be empty. It always is a string which may have a length of zero. 47 These methods are threadsafe by always working with copies.48 47 49 48 Note that you don't have to delete a NOMString object. This is done by the garbage collector. Deleting … … 85 84 In most cases you rather want to use copyCString() instead. 86 85 87 \return The C string representing the contents of the string object. 86 \return The C string representing the contents of the string object. This is not a copy. 88 87 89 88 \sa copyCString() … … 93 92 /** 94 93 Add the NOMString nomString to the end of the string object. 94 95 \remark The returned string object is not newly allocated. Be aware that the string data 96 held by the object is. 95 97 96 98 \param nomString A NOMString object to be put at the end of the string. 97 99 \return 98 The returned NOMString object is a new object which is owned by the caller.100 Modified NOMString object with the given string object appended. This is not a copy. 99 101 100 102 \sa appendCString(), prepend() … … 103 105 104 106 /** 105 Prepend the NOMString \e nomString to the given string object and return a pointer to a 106 new string object. 107 Prepend the NOMString \e nomString to the given string object and return the modified 108 NOMString. 109 110 \remark The returned string object is not newly allocated. Be aware that the string data 111 held by the object is. 107 112 108 113 \param nomString A NOMString object to be put in front of the string. 109 114 \return 110 The returned NOMString object is a new object which is owned by the caller.115 NOMString object with the string prepended. This is not a copy. 111 116 112 117 \sa prependCString() … … 117 122 Append the given C string to the end of the string held by the NOMString object. 118 123 124 \remark The returned string object is not newly allocated. Be aware that the string data 125 held by the object is. 126 119 127 \param chrString A null terminated string. 120 128 \return 121 The NOMString object is a new object which is owned by the caller.129 Modified NOMString object with the C string appended. This is not a copy. 122 130 123 131 \sa append(), prependCString() … … 128 136 Prepend the C string to the string object. 129 137 138 \remark The returned string object is not newly allocated. Be aware that the string data 139 held by the object is. 140 130 141 \param chrString A null terminated string. 131 142 \return 132 The NOMString object is a new object which is owned by the caller.143 Modified NOMString object with the C string prepended. This is not a copy. 133 144 134 145 \sa appendCString(), prepend() … … 144 155 Cuts off the end of a string leaving the first ulNewLen characters. 145 156 146 \return 147 The returned NOMString object is a new object holding the truncated string 148 which is owned by the caller. 157 \remark The returned string object is not newly allocated. Be aware that the string data 158 held by the object is. 159 160 \return 161 Truncated NOMString object. This is not a copy. 149 162 */ 150 163 PNOMString truncate(in unsigned long ulNewLen);
Note:
See TracChangeset
for help on using the changeset viewer.
