Back to FlowSsh Documentation

ClientSessionChannel - PtyRequest

[C]

__cdecl FlowSshC_ClientSessionChannel_PtyRequest(
  FlowSshC_ClientSessionChannel* channel,
  wchar_t const* term,
  unsigned int widthCols,
  unsigned int heightRows
  FlowSshC_ProgressHandler handler,
  void* handlerData);

[C++]

[ClientSessionChannel] void PtyRequest(
  wchar_t const* term,
  unsigned int widthCols,
  unsigned int heightRows
  RefPtr<ProgressHandler> const& progress);

[C#]

[ClientSessionChannel] public void PtyRequest(
  string term,
  uint widthCols,
  uint heightRows,
  ProgressHandler progress);

Parameters

  • [C] channel: FlowSshC_ClientSessionChannel pointer.
  • [C] handler: A ProgressHandler function to be used with the request. Optional.
  • [C] handlerData: An application-defined value to be passed to the handler. Optional.
     
  • term: The terminal environment, for example "xterm" or "vt100".
  • widthCols: Terminal width in columns/characters. The default is usually 80.
  • heightRows: Terminal height in rows/characters. The default is usually 24.
     
  • [Cpp/Net] progress: A ProgressHandler object to be used with the request. Optional.

Remarks

Allocates a PTY (pseudo terminal). Without a PTY the channel is transparent and can be used to safely transfer binary data.