Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

SBlogStream Struct Reference
[VXIlogInterface Implementation]

#include <SBlog.h>

List of all members.


Detailed Description

SBlog definition of a VXIlogStream.

SBlog defines a log stream as the following, which contains methods for writing data and closing the stream.


Public Attributes

VXIlogResult(* Close )(struct SBlogStream **stream)
 Close the stream.
VXIlogResult(* Write )(struct SBlogStream *stream, const VXIbyte *buffer, VXIulong buflen, VXIulong *nwritten)
 Write content to the stream.


Member Data Documentation

VXIlogResult(* SBlogStream::Close)(struct SBlogStream **stream)
 

Close the stream.

Parameters:
stream [IN/OUT] Handle to the stream to close, will be set to NULL on success
Returns:
VXIlog_RESULT_SUCCESS on success

VXIlogResult(* SBlogStream::Write)(struct SBlogStream *stream, const VXIbyte *buffer, VXIulong buflen, VXIulong *nwritten)
 

Write content to the stream.

Parameters:
buffer [IN] Buffer of data to write to the stream
buflen [IN] Number of bytes to write
nwritten [OUT] Number of bytes actual written, may be less then buflen if an error is returned
stream [IN] Handle to the stream to write to
Returns:
VXIlog_RESULT_SUCCESS on success


The documentation for this struct was generated from the following file:
Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2