GetFormatValueFromString
Top  Previous  Next

Description

Returns the numerical code of the specified pixel format.

[C++]
unsigned int
 GetFormatValueFromSting(const char* formatName = 0);

Parameters
[C/C++]
 
[in] const char* formatName  
String containing the name of the pixel format.  
 
 
Return Values

Integer containing the GigE Vision value of the current pixel format.  
E_INVALIDARG if the format is not recognized.  
 
Example
 
The following line of code returns the numerical code of the "Mono12Packed" format :

int FormatId=m_pCamera->GetFormatValueFromString("Mono12Packed");  
 

Remarks


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