MiKTeX 23.10-next
A scalable TeX distribution
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ > Class Template Reference

A callback interface to save process output. More...

#include <miktex/Core/Process.h>

Inheritance diagram for MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >:
Inheritance graph
[legend]
Collaboration diagram for MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >:
Collaboration graph
[legend]

Public Member Functions

bool OnProcessOutput (const void *bytes, std::size_t nBytes) override
 
std::vector< uint8_t > GetStandardOutput () const
 
std::string StdoutToString () const
 
virtual bool OnProcessOutput (const void *output, std::size_t n)=0
 

Detailed Description

template<std::size_t MaxStdoutSize_ = 1024, std::size_t ExpectedStdoutSize_ = 1024>
class MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >

A callback interface to save process output.

Member Function Documentation

◆ GetStandardOutput()

template<std::size_t MaxStdoutSize_ = 1024, std::size_t ExpectedStdoutSize_ = 1024>
std::vector< uint8_t > MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >::GetStandardOutput ( ) const
inline

Gets the saved process output.

Returns
Returns the saved process output as a byte array.

◆ OnProcessOutput()

template<std::size_t MaxStdoutSize_ = 1024, std::size_t ExpectedStdoutSize_ = 1024>
bool MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >::OnProcessOutput ( const void *  output,
std::size_t  n 
)
inlineoverridevirtual

Output function. Called by the Process object if new output text is available.

Parameters
outputOutput text bytes.
nNumber of output text bytes.
Returns
Returns true, if the Process object shall continue.

Implements MiKTeX::Core::IRunProcessCallback.

◆ StdoutToString()

template<std::size_t MaxStdoutSize_ = 1024, std::size_t ExpectedStdoutSize_ = 1024>
std::string MiKTeX::Core::ProcessOutput< MaxStdoutSize_, ExpectedStdoutSize_ >::StdoutToString ( ) const
inline

Gets the saved process output.

Returns
Returns the saved process output as a string.

The documentation for this class was generated from the following file: