Returns the next document available for retrieval from BargeEx as a IDocument object.

Namespace:  BargeEx
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
public GetNextDocumentReturnCode GetNextDocument(
	ref IDocument document
)
Visual Basic (Declaration)
Public Function GetNextDocument ( _
	ByRef document As IDocument _
) As GetNextDocumentReturnCode
Visual C++
public:
GetNextDocumentReturnCode GetNextDocument(
	IDocument^% document
)

Parameters

document
Type: BargeEx..::.IDocument %
Output - If GetNextDocument returns Success and the document retuned can be successfully deserialized into a BargeEx document class instance, this parameter contains the document that was returned.

Return Value

A GetNextDocumentReturnCode value that indicates if a document was returned, no document was available, or an error occurred.

Remarks

This method invokes the GetNextDocument method available from the BargeEx web service. A value of Success indicates the document parameter contains the next available document. A value of NoMoreDocuments indicates no more documents are available at this time. Any other value indicates a failure.

Once the document returned by this method has been successfully processed or persisted, the AcknowledgeDocument method should be called to notify BargeEx to send the next document the next time the GetNextDocument method is called.

See Also