hdc (HDC) - input

Device context handle.

flOptions (ULONG) - input

Options flag.

The only valid option flag is:

LCOLOPT_INDEX

If set, the handling routine must return the index for each RGB value.

lStart (LONG) - input

Starting index for which data is to be returned.

cArray (LONG) - input

Number of elements available in the array.

pArray (PLONG) - input

Pointer to the array in which the information is returned.

When LCOLOPT_INDEX is set, pArray points to an array of alternating color indexes and values (index1, value1, index2, value2, and so forth). If the logical color table is not loaded with a contiguous set of indexes, any index values that are not loaded are skipped.

When LCOLOPT_INDEX is not set, pArray points to an array of RGB color values in which the information is to be returned. Each value is the same as those defined for GreCreateLogColorTable, starting with the specified index and ending when there are no further loaded entries in the table or when cCount has been exhausted. If the logical color table is not loaded with a contiguous set of indexes, QLCT_NOTLOADED is returned as the color value for any index values that are not loaded.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

High-order WORD=flags; low-order WORD=NGreQueryLogColorTable.

rc (LONG) - returns

Return Code.

The handling routine must return a LONG value indicating the number of elements returned in pArray or:

QLCT_ERROR

Error.
QLCT_RGB
Color table is in RGB mode and no elements are returned.
Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:

PMERR_DEV_FUNC_NOT_INSTALLED PMERR_INV_COLOR_OPTIONS
PMERR_INV_COLOR_START_INDEX
PMERR_INV_HDC
PMERR_INV_LENGTH_OR_COUNT

Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

---

[Back: GreQueryLogColorTable Return Value - rc]
[Next: GreQueryLogColorTable - Topics]