cwbCO_GetPromptMode

Use the cwbCO_GetPromptMode command.

Purpose

This function gets, for the specified system object, the prompt mode that currently is set.

Syntax

 
UINT CWB_ENTRY cwbCO_GetPromptMode(
                             cwbCO_SysHandle       system,
                             cwbCO_PromptMode     *mode );

Parameters

cwbCO_SysHandle system - input: Handle that previously was returned from cwbCO_CreateSystem or cwbCO_CreateSystemLikeIt is the IBM i identification.
cwbCO_PromptMode * mode - output: Returns the prompt mode. See comments for cwbCO_SetPromptMode for possible values and their meanings.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWB_INVALID_API_HANDLE: Invalid system handle.
CWB_INVALID_POINTER: The mode pointer is NULL.

Usage

None.