S4ServiceClient.annotateDocumentAsStream Method

S4ServiceClientannotateDocumentAsStream Method

A Sandcastle Documented Class Library

Annotates a single document and returns an {@link InputStream} from which the contents of the serialized annotated document can be read

Namespace: Ontotext.S4.service
Assembly: S4ClientLibrary (in S4ClientLibrary.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public Stream annotateDocumentAsStream(
	string documentText,
	SupportedMimeType documentMimeType,
	ResponseFormat serializationFormat
)

Public Function annotateDocumentAsStream ( 
	documentText As String,
	documentMimeType As SupportedMimeType,
	serializationFormat As ResponseFormat
) As Stream

public:
Stream^ annotateDocumentAsStream(
	String^ documentText, 
	SupportedMimeType documentMimeType, 
	ResponseFormat serializationFormat
)

member annotateDocumentAsStream : 
        documentText : string * 
        documentMimeType : SupportedMimeType * 
        serializationFormat : ResponseFormat -> Stream

Parameters

documentText: Type: SystemString
the contents of the document which will be annotated
documentMimeType: Type: Ontotext.S4.serviceSupportedMimeType
the MIME type of the file which will be annotated
serializationFormat: Type: Ontotext.S4.serviceResponseFormat
the format which will be used for serialization of the annotated document

Return Value

Type: Stream
an {@link InputStream} from which the serialization of the annotated document can be read

Reference

S4ServiceClient Class

Ontotext.S4.service Namespace