OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



VXIlogResult ContentOpen

(struct VXIlogInterface* pThis,
  const VXIchar* moduleName,
  const VXIchar* contentType,
  VXIString** logKey,
  VXIString** logValue,
  VXIlogStream** stream)

Open a handle to log (potentially large or binary) content NOTE: This is only available as of version 1.1 of the VXIlogInterface, use LOG_CONTENT_METHODS_SUPPORTED( ) to determine availability.
In situations where large blocks of data need to be logged and/or the data is binary, this method should be used to open a content logging stream. Data is written via ContentWrite( ), and the stream is then closed via ContentClose( ). The key/value pair returned by this method indicates the location of the logged data, and should be used to reference this content within error, event, and/or diagnostic messages.

Parameters:
moduleName - [IN] Name of the software module that is outputting the data. See the top of this file for moduleName allocation rules.
- contentType [IN] MIME content type for the data
logKey - [OUT] Key name to cross-reference this content in logging errors, events, and/or diagnostic messages. Ownership is passed on success, call VXIStringDestroy( ) to free this when no longer required.
logValue - [OUT] Value to cross-reference this content in logging errors, events, and/or diagnostic messages. Ownership is passed on success, call VXIStringDestroy( ) to free this when no longer required.
stream - [OUT] Handle for writing the content via ContentWrite( ) and closing it via ContentClose( )
Returns:
VXIlog_RESULT_SUCCESS on success

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.