GetColorProfileFromHandle function (icm.h)

  • Article

Given a handle to an open color profile, the GetColorProfileFromHandle function copies the contents of the profile into a buffer supplied by the application. If the handle is a Windows Color System (WCS) handle, then the DMP is returned and the CAMP and GMMP associated with the HPROFILE are ignored.

Syntax

BOOL GetColorProfileFromHandle(
  HPROFILE hProfile,
  PBYTE    pProfile,
  PDWORD   pcbProfile
);

Parameters

hProfile

Handle to an open color profile. The function determines whether the HPROFILE contains ICC or WCS profile information.

pProfile

Pointer to buffer to receive raw ICC or DMP profile data. Can be NULL. If it is, the size required for the buffer will be stored in the memory location pointed to by pcbSize. The buffer can be allocated to the appropriate size, and this function called again with pBuffer containing the address of the buffer.

pcbProfile

Pointer to a DWORD that holds the size of buffer pointed at by pBuffer. On return it is filled with size of buffer that was actually used if the function succeeds. If this function is called with pBuffer set to NULL, this parameter will contain the size of the buffer required.

Return value

If this function succeeds, the return value is TRUE. It returns FALSE if the pBuffer parameter is NULL and the size required for the buffer is copied into pcbSize.

If this function fails, the return value is FALSE. For extended error information, call GetLastError.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header icm.h
Library Mscms.lib
DLL Mscms.dll

See also