GetType Function

Retrieves the type of a particular prompt.

Syntax

GetType(
    IPROMPTSET_HANDLE i_hIPromptSet, 
    int i_iIndex,
    int* o_type)

    Parameters

i_hIPromptSet [In]

The handle to the IPromptSet interface. See hIPromptSet Variable.

i_iIndex [In]

The prompt's index number.

o_type [Out]

The prompt type.

Returns

Each function returns a RET_VALUE that is an error code of type Long. The return value is greater than zero if the call was successful, and zero or less if not. Use RET_OK(x) and RET_ERROR(x) to check for failure.

Remarks

The prompt type may be one of the following:

Constant	Value
PROMPTTYPE_INVALID	0
PROMPTTYPE_NUMBER	1
PROMPTTYPE_CURRENCY	2
PROMPTTYPE_BOOL	3
PROMPTTYPE_DATE	4
PROMPTTYPE_TIME	5
PROMPTTYPE_DATETIME	6
PROMPTTYPE_STRING	7