API browser of generalnotification450 COM module


/images/arrow_right.png IGeneralNotificationRequest::AddDocument method
Attaches a PDF, JPG or PNG document to the list of documents.

Internally, the document will be transformed to a BASE64 octet representation to safeguard the binary nature of the file.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT AddDocument( BSTR
BSTR
BSTR
VARIANT_BOOL
bstrFile,
bstrTitle,
bstrMimeType,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrFile bstrFile supplies the full file name (path + name) of the document. Be sure, that privileges allows to open and read the file since the content is internally BASE64 coded.
[in] BSTR bstrTitle bstrTitle is the document's title on the primary system and thus describes the document in terms of its semantic content.
[in] BSTR bstrMimeType The MIME type of the document. The MIME type enables applications to define the format and eventually read the file (cf. RFC 2046 standardizes and names the commonly used MIME types).

Since the underlying XSD schema restricts the type of files, the MIME type must>/b> be one of

  • application/pdf for PDF files, , and image/png
  • image/jpeg for JPG graphic files
  • image/png for PNG graphic files
[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.