SetTerminationCharacter

Sets the termination character for read operations.

Syntax

virtual HRESULT SetTerminationCharacter(UCHAR cTermChar) abstract;

Parameters

cTermChar

[in] A single character that, when read from the device, causes the read operation to terminate.

Return value

Returns S_OK if successful, otherwise a failure HRESULT.

Remarks

When the termination character is read and it has been enabled via the SetTerminationCharacterEnabled function, the read operation terminates.

The default termination character is set to the newline character (\n) and it is enabled by default.

Example

The following example demonstrates use of the SetTerminationCharacter function.

HRESULT Acme4321::OnFinalInitialize()
{
  HRESULT hr = S_OK;

  // Set the termination character to a carriage-return (\r)
  hr = io.SetTerminationCharacter('\r');

  return hr;
}