LlmGetHistorySize Function  
 
LONG WINAPI LlmGetHistorySize(
  HCLIENT hClient  
);

The LlmGetHistorySize function returns the maximum number of message exchanges that can be stored in the conversation history.

Parameters

hClient
A handle to the client session.

Return Value

If the function succeeds, the return value is the maximum size of the conversation history for the client session. If the function fails, the return value is LLM_ERROR. To get extended error information, call LlmGetLastError.

Remarks

The LlmGetHistorySize function returns the maximum number of messages which can be stored in the client conversation history. Each message represents a single request submitted to the model and its associated response.

The conversation history is maintained on a per-session basis and reflects the sequence of interactions performed using the client handle. Messages are stored in chronological order, with new messages appended to the end of the history. To retrieve the contents of a specific message and response from the history, use either the LlmGetMessage or LlmGetMessageById functions.

It is possible to disable the conversation history by calling the LlmSetHistorySize function and specifying a maximum history size of zero. In this case, this function will always return zero.

Requirements

Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools12.h
Import Library: csllmv12.lib

See Also

LlmGetFirstMessage, LlmGetMessage, LlmGetMessageById, LlmGetNextMessage, LlmSetHistorySize