VM_QUERYITEM Return Value - ulItemId

ulItemId (ULONG)

Item information.

This value depends on the VIA_* attribute specified for the value set item.

• If the VIA_TEXT attribute is set, the following is returned:

  usTextLen (USHORT)

  Number of bytes copied to the buffer. This is the length of the text string, excluding the null termination character.
  
  If the VIA_BITMAP attribute is set, the following is returned:

  hbmItem (HBITMAP)

  Handle of the bit map associated with the item indexed by the param1 parameter. If the item is empty, a NULL value is returned.
  
  If the VIA_ICON attribute is set, the following is returned:

  hptItem (HPOINTER)

  Handle of the icon associated with the item indexed by the param1 parameter. If the item is empty, a NULL value is returned.
  
  If the VIA_RGB attribute is set, the following is returned:

  rgbItem (ULONG)

  Color value associated with the item indexed by the param1 parameter. If the item is empty, a NULL value is returned. Each color value is a 4-byte integer with a value of:

  (R * 65536) + (G * 256) + B
  

  where:

  R

  Red intensity value
  G
  Green intensity value
  B
  Blue intensity value.
  
  If the VIA_COLORINDEX attribute is set, the following is returned:

  ulColorIndex (ULONG)

  Index of the color associated with the item indexed by the param1 parameter.
  The following is returned for any of the items to indicate an error condition:

  VSERR_INVALID_PARAMETERS

  An error occurred. The WinGetLastError function may return the following errors:

  • PMERR_INVALID_PARAMETERS 
    PMERR_PARAMETER_OUT_OF_RANGE.

    ---

    [Back: VM_QUERYITEM Field - pvsText]
    [Next: VM_QUERYITEM - Parameters]