The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormResult::GetFirstDocument method space
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 Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResult/GetFirstDocument
[JSON input data] pIGeneralFormResult: longValue,    //interface address
[JSON result data] pbstrFile:
pbstrTitle:
pbstrMimeType:
pbStatus:		 "utf8StringValue",
"utf8StringValue",
"utf8StringValue",
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstDocument( BSTR
BSTR
BSTR
VARIANT_BOOL 		*pbstrFile,
*pbstrTitle,
*pbstrMimeType,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
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.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrFile *pbstrFile 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!

In Restful Webservice output: pbstrFile is a relative URL that subsequently must be downloaded by a GET process.
[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.

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

  • application/pdf for PDF files
  • 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 the end of data is reached
space