Changeset 13856 in vbox for trunk/include/VBox/com
- Timestamp:
- Nov 5, 2008 1:30:07 PM (16 years ago)
- svn:sync-xref-src-repo-rev:
- 38852
- Location:
- trunk/include/VBox/com
- Files:
-
- 7 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/VBox/com/ErrorInfo.h
r13580 r13856 53 53 * the current thread is cleared. 54 54 * 55 * There is no sen ce to use instances of this class after the last55 * There is no sense to use instances of this class after the last 56 56 * invoked interface method returns a success. 57 57 * … … 307 307 308 308 /** 309 * Constructs a new instance by fetchi g error information from the309 * Constructs a new instance by fetching error information from the 310 310 * IProgress interface pointer. If the progress object is not NULL, 311 311 * its completed attribute is true, resultCode represents a failure, … … 330 330 * 331 331 * Instead of calling #restore() explicitly you may let the object destructor 332 * do it for you, if you correctly limit the object's life ime.332 * do it for you, if you correctly limit the object's lifetime. 333 333 * 334 334 * The usage pattern is: -
trunk/include/VBox/com/SupportErrorInfo.h
r13580 r13856 83 83 * error or warning but continues its execution, the functionality provided 84 84 * by the base com::FWResult class becomes very useful because it allows to 85 * prese ve the error or the warning result code even if it is later assigned85 * preserve the error or the warning result code even if it is later assigned 86 86 * a S_OK value multiple times. See com::FWResult for details. 87 87 * … … 137 137 * it in case of expressions like |MultiResult rc = E_FAIL;|. But 138 138 * we assert since the optimizer should actually avoid the 139 * temporary and call the other constructor directly i stead. */139 * temporary and call the other constructor directly instead. */ 140 140 AssertFailed(); 141 141 } … … 154 154 * it in case of expressions like |MultiResult rc = E_FAIL;|. But 155 155 * we assert since the optimizer should actually avoid the 156 * temporary and call the other constructor directly i stead.*/156 * temporary and call the other constructor directly instead */ 157 157 AssertFailed(); 158 158 return *this; … … 210 210 * 211 211 * Basic error info support includes a group of setError() methods to set 212 * extended error information on the current thread. This support does nnot212 * extended error information on the current thread. This support does not 213 213 * include all necessary implementation details (for example, implementation of 214 214 * the ISupportErrorInfo interface on MS COM) to make the error info support … … 273 273 * </pre> 274 274 * 275 * Note that this is a generic me htod. There are more convenient overloaded275 * Note that this is a generic method. There are more convenient overloaded 276 276 * versions that automatically substitute some arguments taking their 277 277 * values from the template parameters. See #setError (HRESULT, const char … … 304 304 * IVirtualBoxErrorInfo object. 305 305 * 306 * The error severity bit is always cleared by this call, thereof eyou can307 * use ordinary E_XXX result code constan cs, for convenience. However, this308 * behavior may be non-stan rard on some COM platforms.306 * The error severity bit is always cleared by this call, thereof you can 307 * use ordinary E_XXX result code constants, for convenience. However, this 308 * behavior may be non-standard on some COM platforms. 309 309 */ 310 310 static HRESULT setWarning (HRESULT aResultCode, const GUID &aIID, -
trunk/include/VBox/com/array.h
r13648 r13856 156 156 * SafeConstGUIDArray, customized SafeArray<> specializations. 157 157 * 158 * Also note that in order to pass input BSTR array parameters de lcared158 * Also note that in order to pass input BSTR array parameters declared 159 159 * using the ComSafeArrayIn (INPTR BSTR, aParam) macro to the SafeArray<> 160 160 * constructor using the ComSafeArrayInArg() macro, you should use INPTR BSTR … … 181 181 * Wraps the given com::SafeArray instance to generate an expression that is 182 182 * suitable for passing it to functions that take input safearray parameters 183 * declared using the ComSafeArrayIn ma rco.183 * declared using the ComSafeArrayIn macro. 184 184 * 185 185 * @param aArray com::SafeArray instance to pass as an input parameter. … … 191 191 * Wraps the given com::SafeArray instance to generate an expression that is 192 192 * suitable for passing it to functions that take output safearray parameters 193 * declared using the ComSafeArrayOut ma rco.193 * declared using the ComSafeArrayOut macro. 194 194 * 195 195 * @param aArray com::SafeArray instance to pass as an output parameter. … … 486 486 * resources occupied by individual elements of the array as well as by the 487 487 * array itself. However, when the value of an element is manually changed 488 * using #operator[] or by ac essing array data through the #raw() pointer, it is488 * using #operator[] or by accessing array data through the #raw() pointer, it is 489 489 * the caller's responsibility to free resources occupied by the previous 490 490 * element's value. … … 496 496 * use normal list/vector classes for that. 497 497 * 498 * @note The current implementation supports only one-dimen tional arrays.498 * @note The current implementation supports only one-dimensional arrays. 499 499 * 500 500 * @note This class is not thread-safe. … … 610 610 /** 611 611 * Resets this instance to null and, if this instance is not a weak one, 612 * releases any resources oc uppied by the array data.612 * releases any resources occupied by the array data. 613 613 * 614 614 * @note This method destroys (cleans up) all elements of the array using … … 727 727 * instance is null or if the index is out of bounds. 728 728 * 729 * @note For weak instances, this call will succeed but the be iavior of729 * @note For weak instances, this call will succeed but the behavior of 730 730 * changing the contents of an element of the weak array instance is 731 731 * undefined and may lead to a program crash on some platforms. … … 843 843 #if defined (VBOX_WITH_XPCOM) 844 844 845 /** Internal func iton. Never call it directly. */845 /** Internal function. Never call it directly. */ 846 846 PRUint32 *__asOutParam_Size() { setNull(); return &m.size; } 847 847 848 /** Internal func iton.Never call it directly. */848 /** Internal function Never call it directly. */ 849 849 T **__asOutParam_Arr() { Assert (isNull()); return &m.arr; } 850 850 851 851 #else /* defined (VBOX_WITH_XPCOM) */ 852 852 853 /** Internal func iton.Never call it directly. */853 /** Internal function Never call it directly. */ 854 854 SAFEARRAY ** __asInParam() { return &m.arr; } 855 855 856 /** Internal func iton.Never call it directly. */856 /** Internal function Never call it directly. */ 857 857 SAFEARRAY ** __asOutParam() { setNull(); return &m.arr; } 858 858 … … 961 961 * and out arrays are |nsID ***|. Due to this difference, it is impossible to 962 962 * work with arrays of GUID on both platforms by simply using com::SafeArray 963 * <GUID>. This class is intended to provide some leve of cross-platform963 * <GUID>. This class is intended to provide some level of cross-platform 964 964 * behavior. 965 965 * … … 1052 1052 * 1053 1053 * This class is used to work with input GUID array parameters in method 1054 * implementa itons. See SafeGUIDArray for more details.1054 * implementations. See SafeGUIDArray for more details. 1055 1055 */ 1056 1056 class SafeConstGUIDArray : public SafeArray <const nsID *, -
trunk/include/VBox/com/assert.h
r13183 r13856 288 288 /** 289 289 * Asserts the given expression is true. When the expression is false, prints 290 * a line containing the fail ied function/line/file; otherwise does nothing.290 * a line containing the failed function/line/file; otherwise does nothing. 291 291 */ 292 292 #define ASSERT(expr) \ -
trunk/include/VBox/com/com.h
r8155 r13856 55 55 * Resolves a given interface ID to a string containing the interface name. 56 56 * If, for some reason, the given IID cannot be resolved to a name, a NULL 57 * string is returned. A non-NULL string returned by this func iton must be57 * string is returned. A non-NULL string returned by this function must be 58 58 * freed using SysFreeString(). 59 59 * … … 63 63 void GetInterfaceNameByIID (const GUID &aIID, BSTR *aName); 64 64 65 /** 65 /** 66 66 * Returns the VirtualBox user home directory. 67 67 * 68 68 * On failure, this function will return a path that caused a failure (or 69 * NULL if the fai ulre is not path-related).69 * NULL if the failure is not path-related). 70 70 * 71 71 * On success, this function will try to create the returned directory if it -
trunk/include/VBox/com/ptr.h
r9332 r13856 229 229 230 230 /** 231 * Derefere ces the instance (redirects the -> operator to the managed231 * Dereferences the instance (redirects the -> operator to the managed 232 232 * pointer). 233 233 */ … … 344 344 345 345 /** 346 * Create as an in-process object of the given class ID and starts to346 * Creates an in-process object of the given class ID and starts to 347 347 * manage a reference to the created object in case of success. 348 348 */ … … 368 368 369 369 /** 370 * Create as a local (out-of-process) object of the given class ID and starts370 * Creates a local (out-of-process) object of the given class ID and starts 371 371 * to manage a reference to the created object in case of success. 372 372 * … … 394 394 #ifdef VBOX_WITH_XPCOM 395 395 /** 396 * Create as an object of the given class ID on the specified server and396 * Creates an object of the given class ID on the specified server and 397 397 * starts to manage a reference to the created object in case of success. 398 398 * -
trunk/include/VBox/com/string.h
r13580 r13856 284 284 /** 285 285 * Helper class that represents UTF8 (|char *|) strings. Useful in 286 * conjunction with Bstr to simplify conversions be etween UTF16 (|BSTR|)286 * conjunction with Bstr to simplify conversions between UTF16 (|BSTR|) 287 287 * and UTF8. 288 288 * … … 629 629 630 630 /** 631 * T He BstrFmt class is a shortcut to <tt>Bstr (Utf8StrFmt (...))</tt>.631 * The BstrFmt class is a shortcut to <tt>Bstr (Utf8StrFmt (...))</tt>. 632 632 */ 633 633 class BstrFmt : public Bstr … … 652 652 653 653 /** 654 * T He BstrFmtVA class is a shortcut to <tt>Bstr (Utf8StrFmtVA (...))</tt>.654 * The BstrFmtVA class is a shortcut to <tt>Bstr (Utf8StrFmtVA (...))</tt>. 655 655 */ 656 656 class BstrFmtVA : public Bstr
Note:
See TracChangeset
for help on using the changeset viewer.