The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
generating electronic and paper based credit requests
API browser of generalCreditRequest430 COM module
IGeneralCreditRequest::AddDocument method | |||
---|---|---|---|
Adds one document -either inline or online- to the list of documents. | |||
C/C++ calling syntax | |||
HRESULT AddDocument( | YesNoType
BSTR BSTR BSTR BSTR VARIANT_BOOL |
eIsURL,
bstrSource, bstrFilename, bstrMimeType, bstrViewer, *pbStatus); |
|
Calling argument description | |||
[in] YesNoType | eIsURL | Boolean that defines if the document is added online using a URL (enYes) or inline as Base64 coded stream (enNo). | |
[in] BSTR | bstrSource | If eIsURL = enYes then bstrSource is a URL for accessing the file online.
If eIsURL = enNo then bstrSource is a full file name (path + name) that is Base64 coded. Note that the file must exist and having READ access. |
|
[in] BSTR | bstrFilename | The name of the file (without path) in the local file system.
This information is an aid for saving the file at the target location. |
|
[in] BSTR | bstrMimeType | The MIME type of the document. The MIME type enables applications to read the file.
RFC 2046 standardizes and names the commonly used MIME types. |
|
[in] BSTR | bstrViewer | An optional URL where a viewer for the file can be downloaded. | |
[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. | |
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. | ||