API browser of hospitalMCDRequest451 COM module


/images/arrow_right.png IHospitalMCDResult::GetFirstDocument method
Retrieves the first document from the list of documents.

VARIANT_FALSE is returned if the end of the document list is reached.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstDocument( YesNoType
BSTR
BSTR
BSTR
VARIANT_BOOL
*peIsURL,
*pbstrSource,
*pbstrTitle,
*pbstrMimeType,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] YesNoType *peIsURL Boolean that defines if the document is added online using a URL (enYes) or inline as Base64 coded stream (enNo).
[out] BSTR *pbstrSource If eIsURL = enYes then bstrSource is a URL for accessing the file online.

If eIsURL = enNo then bstrSource supplies the full file name (path + name) of the document in a temporary working directory.
Be sure to copy away the file to a different location as all files in the working directory are deleted before the COM module shuts down!

[out] BSTR *pbstrTitle The title of the document on the primary system. It thus describes the document to a certain degree in terms of its semantic content.
[out] BSTR *pbstrMimeType The MIME type of the document.
[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
 
/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.