> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/telecom-references/developer-reference/caf/ctbcaflog.md).

# CTBCAFLog

The class *CTBCAFLog* automatically writes calls to "LogTrace" function (which the CAF library itself uses to log useful information) to log files. It also manages log files rotation and zipping.

This module should be initialized through the *GlobalSetParams* function. Parameters for this module are contained in class *CTBCAFLogParams*

Please refer to documentation in the C++ header files for class *CTBCAFLogParams* to know more about available parameters.

### Example usage

```
TBX_RESULT MyApplication::Init()
{
TBX_RESULT			Result = TBX_RESULT_OK;
CTBCAFGlobalsParams	CafGlobalParams;
CTBCAFLogParams		CafLogParams;

// Set the parameters you want
CafLogParams.mstrApplicationName	= "MyApplication";
CafLogParams.mstrLogFilePath		= "";	// In working directory, automatically based on application name and date
CafLogParams.mfUseXMLPrint			= TBX_FALSE;
// (other parameters are generally left to default values)

CafGlobalParams.mpLogParams			= &CafLogParams;
// CafGlobalParams.mpCommParams		= [your paramters...]
// CafGlobalParams.mpCliParams		= [your paramters...]
// etc...

Result = TBCAF::GlobalSetParam( &CafGlobalParams );

return Result;
}

TBX_RESULT MyApplication::UnInit()
{
TBX_RESULT			Result = TBX_RESULT_OK;
CTBCAFGlobalsParams		EmptyGlobalParams;

// Terminate all CAF modules
Result = TBCAF::GlobalSetParam( &EmptyGlobalParams );

return Result;
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://prosbcdocs.telcobridges.com/telecom-references/developer-reference/caf/ctbcaflog.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
