[Overview][Constants][Types][Procedures and functions][Index] Reference for unit 'amigados' (#aros)

GetPrompt

Returns the prompt for the current process

Declaration

Source position: amigados.pas line 2342

function GetPrompt(

  Buf: STRPTR;

  Len: LongInt

):LongBool;

Arguments

Buf

  

Buffer to hold extracted prompt

Len

  

Number of bytes of space in buffer

Description

Extracts the prompt string from the CLI structure and puts it into the buffer. If the buffer is too small, the string is truncated appropriately and a failure code returned. If no CLI structure is present, a null string is returned in the buffer, and failure from the call (with IoErr() = ERROR_OBJECT_WRONG_TYPE);

See also

SetPrompt

  

Sets the CLI/shell prompt for the current process


Documentation generated on: 2017-01-10