GetFormatStringFromValue
Top  Previous  Next

Description

Returns the name of the pixel format specified by its numerical ID.

[C++]
const char* 
GetFormatStringFromValue(unsigned int formatID = 0);

Parameters
[C/C++]
 
[in] unsigned int formatID  
Integer containing the numerical ID of the pixel format.  
 
 
Return Values

String containing the name of the pixel format.  
NULL if the format is not recognized.  
 
 
Example
 
The following line of code converts a format ID into a string :

char* FormatId=m_pCamera->GetFormatValueFromString(0x010C0027);  
 

Remarks


This method converts the numerical value of the pixel format to its string name. For the list of possible format values refer to the table in SetPixelFormat.