S4ServiceClient.annotateFileContentsAsStream Method

S4ServiceClientannotateFileContentsAsStream Method

A Sandcastle Documented Class Library

Annotates the contents of a single file returning an {@link InputStream} from which the annotated content can be read

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

Syntax

public Stream annotateFileContentsAsStream(
	FileStream documentContent,
	string documentEncoding,
	SupportedMimeType documentMimeType,
	ResponseFormat serializationFormat
)

Public Function annotateFileContentsAsStream ( 
	documentContent As FileStream,
	documentEncoding As String,
	documentMimeType As SupportedMimeType,
	serializationFormat As ResponseFormat
) As Stream

public:
Stream^ annotateFileContentsAsStream(
	FileStream^ documentContent, 
	String^ documentEncoding, 
	SupportedMimeType documentMimeType, 
	ResponseFormat serializationFormat
)

member annotateFileContentsAsStream : 
        documentContent : FileStream * 
        documentEncoding : string * 
        documentMimeType : SupportedMimeType * 
        serializationFormat : ResponseFormat -> Stream

Parameters

documentContent: Type: System.IOFileStream
the file which will be annotated
documentEncoding: Type: SystemString
the encoding of the file 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 serialization format used for the annotated content

Return Value

Type: Stream
an {@link InputStream} from which

Reference

S4ServiceClient Class

Ontotext.S4.service Namespace