[aaf-commits] AAF/ref-impl/include/ref-api AAF.h,1.35,1.36

[Tim B. <tbi...@us...>]

Update of /cvsroot/aaf/AAF/ref-impl/include/ref-api
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16313/ref-impl/include/ref-api

Modified Files:
	AAF.h 
Log Message:
Stubbed implementation of AAFResultToText() and AAFResultToTextBufLen().

Index: AAF.h
===================================================================
RCS file: /cvsroot/aaf/AAF/ref-impl/include/ref-api/AAF.h,v
retrieving revision 1.35
retrieving revision 1.36
diff -C2 -d -r1.35 -r1.36
*** AAF.h	7 Jun 2006 16:07:29 -0000	1.35
--- AAF.h	8 Jun 2006 14:55:10 -0000	1.36
***************
*** 50339,50342 ****
--- 50339,50417 ----
      aafUInt32  bufSize);
  
+   //***********************************************************
+   //
+   // AAFResultToTextBufLen()
+   //
+   /// Returns the size of the buffer, in bytes, required for the AAFResultToText() function.
+   ///
+   /// Succeeds if all of the following are true:
+   /// - the pResultTextSize pointer is valid.
+   /// - the result is an AAFRESULT.
+   /// - the result is a recognized AAFRESULT.
+   ///
+   /// If this method fails nothing will be written to *pResultTextSize.
+   ///
+   /// This method will return the following codes:
+   /// 
+   /// AAFRESULT_SUCCESS
+   ///   - succeeded.
+   ///
+   /// AAFRESULT_NULL_PARAM
+   ///   - pResultTextSize arg is NULL.
+   ///
+   /// AAFRESULT_RESULT_NOT_AAF
+   ///   - result is not an AAFRESULT.
+   ///
+   /// AAFRESULT_RESULT_NOT_RECOGNIZED
+   ///   - result is not a recognized AAFRESULT.
+   /// 
+   /// @param result [in] The result
+   /// @param pResultTextSize [out] The size of the required buffer, in bytes.
+   /// 
+   STDAPI AAFResultToTextBufLen (
+     AAFRESULT  result,
+     aafUInt32 *   pResultTextSize);
+ 
+ 
+   //***********************************************************
+   //
+   // AAFResultToText()
+   //
+   /// /// Returns the text representation of an AAFRESULT.
+   ///
+   /// Succeeds if all of the following are true:
+   /// - the pResultText pointer is valid.
+   /// - the result is an AAFRESULT.
+   /// - the result is a recognized AAFRESULT.
+   /// - the buffer is large enough to hold the result text.
+   ///
+   /// If this method fails nothing will be written to resultText.
+   ///
+   /// This method will return the following codes:
+   /// 
+   /// AAFRESULT_SUCCESS
+   ///   - succeeded.
+   ///
+   /// AAFRESULT_NULL_PARAM
+   ///   - pResultText arg is NULL.
+   ///
+   /// AAFRESULT_RESULT_NOT_AAF
+   ///   - result is not an AAFRESULT.
+   ///
+   /// AAFRESULT_RESULT_NOT_RECOGNIZED
+   ///   - result is not a recognized AAFRESULT.
+   ///
+   /// AAFRESULT_SMALLBUF
+   ///   - pResultText is too small to hold the result text.
+   /// 
+   /// @param result [in] The result
+   /// @param pResultText [out, string, size_is(resultTextSize)] The text representation of the result
+   /// @param resultTextSize [in] The size, in bytes, of pResultText
+   /// 
+   STDAPI AAFResultToText (
+     AAFRESULT  result,
+     aafCharacter *  pResultText,
+     aafUInt32  resultTextSize);
+ 
  
  #endif // __AAF_h__