GetStandardColorSpaceProfile

[This is preliminary documentation and subject to change.]

The GetStandardColorSpaceProfile function retrieves the color profile registered for the specified standard color space.

BOOL WINAPI GetStandardColorSpaceProfile(
  PCTSTR pMachineName,
  DWORD dwProfileID,
  PTSTR pProfileName,
  PDWORD pdwSize
);
 

Parameters

pMachineName

Reserved for future use; must be NULL. This parameter is intended to point to the name of the computer on which to get a standard color space profile. A NULL pointer indicates the local machine.

dwProfileID

Specifies the ID value of the standard color space for which to retrieve the profile.

pProfileName

Pointer to the buffer in which the name of the profile is to be placed. If NULL, the call will return FALSE and the required size of the buffer is placed in pdwSize.

pdwSize

Pointer to a variable containing the size in bytes of the buffer pointed to by pProfileName. On return, the variable contains the size of the buffer actually used or needed.

Return Values

If this function succeeds, the return value is TRUE.

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

Remarks

If the buffer pointed to by pProfileName is to be dynamically allocated by an application, the application can call the GetStandardColorSpaceProfile function to retrieve the size required for the buffer. If GetStandardColorSpaceProfile is called with pProfileName set to NULL, it will return FALSE and the DWORD pointed at by pdwSize will contain the number of bytes needed for the buffer pointed at by pProfileName. The application can then allocate the buffer and call GetStandardColorSpaceProfile again with pProfileName set to the address of the buffer.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in icm.h.
  Import Library: Use mscms.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Color Management Overview, ICM 2.0 Functions, SetStandardColorSpaceProfile