Platforms to show: All Mac Windows Linux Cross-Platform
Back to WindowsICMProfileMBS class.
WindowsICMProfileMBS.ConvertColorNameToIndex(name as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
name: The name of the color.
Returns the color index.
This function is required in the default CMM. It is optional for all other CMMs.
WindowsICMProfileMBS.ConvertIndexToColorName(index as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This function is required in the default CMM. It is optional for all other CMMs.
WindowsICMProfileMBS.CountColorProfileElements as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Returns number of tagged elements in the profile or 0 on any error.
This function will fail if hProfile is not a valid ICC profile.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP.
Some examples using this method:
WindowsICMProfileMBS.CreateIccProfile(options as Integer = 0) as WindowsICMProfileMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 14.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Options: A flag value that specifies the profile conversion options.By default, the original WCS profiles used for the conversion are embedded in the output ICC profile in a Microsoft private tag, ProfilesTag (with signature "MS000". This produces an ICC profile that is compatible with ICC software, yet retains the original WCS profile data available to code designed to parse it.The possible values of this parameter are as follows. Any bits not defined in this list are reserved and should be set to zero:
WCS_DEFAULT | Specifies that the new ICC profile contains the original WCS profile in a private ProfilesTag. |
WCS_ICCONLY | Specifies that the new ICC profile does not contain either the ProfilesTag or the original WCS profile. |
Returns new profile object.
see also
http://msdn.microsoft.com/en-us/library/windows/desktop/dd372239(v=vs.85).aspx
WindowsICMProfileMBS.GetColorProfileElement(tag as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
tag: Identifies the tagged element from which to copy.
This function will fail if Profile is not a valid International Color Consortium (ICC) profile.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP; because profile elements are implicitly associated with, and hard coded to, ICC tag types and there exist many robust XML parsing libraries.
Some examples using this method:
WindowsICMProfileMBS.GetColorProfileElementTag(index as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Index: Specifies the one-based index of the tag to retrieve.
This function will fail if Profile is not a valid ICC profile.
GetColorProfileElementTag can be used to enumerate all tags in a profile after getting the number of tags in the profile using GetCountColorProfileElements.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP; because profile elements are implicitly associated with, and hard coded to, ICC tag types and there exist many robust XML parsing libraries.
Some examples using this method:
WindowsICMProfileMBS.GetNamedProfileInfo as WindowsICMNamedProfileInfoMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This function will fail if hProfile is not a valid ICC profile.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP; because named profiles are explicit ICC profile types.
Returns nil on any error.
WindowsICMProfileMBS.GetProfileData as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If the object is a Windows Color System (WCS) handle, then the DMP is returned and the CAMP and GMMP associated with the HPROFILE are ignored.
Returns the data or an empty string on any error.
See GetColorProfileFromHandle in MSDN documentation.
WindowsICMProfileMBS.IsColorProfileTagPresent(tag as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
tag: Specifies the ICC tag to check.
Returns true if the tag is valid and false if not.
This function will fail if Profile is not a valid ICC profile.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP; because profile elements are implicitly associated with and hard coded to ICC tag types and there exist many robust XML parsing libraries.
WindowsICMProfileMBS.IsValid as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Returns true if the profile is valid.
Only the Windows default CMM is required to export this function; it is optional for all other CMMs.
If a CMM does not support this function, Windows uses the default CMM to validate the profile.
WindowsICMProfileMBS.SetColorProfileHeader(header as WindowsICMProfileHeaderMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Windows ICM | MBS Win Plugin | 11.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Header: the profile header data to write to the specified profile.
Returns true on success.
This function will fail if Profile is not a valid ICC profile.
If the color profile was not opened with read/write permission, SetColorProfileHeader fails.
SetColorProfileHeader overwrites the current header in the ICC profile.
This function does not support Windows Color System (WCS) profiles CAMP, DMP, and GMMP; because profile elements are implicitly associated with and hard coded to ICC tag types and there exist many robust XML parsing libraries.
The items on this page are in the following plugins: MBS Win Plugin.