GetTerminationCharacterEnabled

Indicates whether the I/O termination character for read operations is enabled or disabled.

Syntax

virtual HRESULT GetTerminationCharacterEnabled(bool* pbEnabled) abstract;

Parameters

pbEnabled

[out] When true, the termination character is used to determine when a read operation ends.

Return value

Returns S_OK if successful, otherwise a failure HRESULT.

Remarks

When the termination character is enabled, the termination character specified with the SetTerminationCharacter function determines when 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 GetTerminationCharacterEnabled function.

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

  bool bEnabled;
  hr = io.GetTerminationCharacterEnabled(&bEnabled);

  return hr;
}