DeleteEnumEntry
Top  Previous  Next

Description

Deletes the specified entry from the enumerated feature.


Syntax


[C++]
int
 DeleteEnumEntry (const char* feature, const char* name);


Parameters
[C/C++]
 
[in] const char* feature  
Name of the feature. Must be an existing feature of the enumerated type.  
 
[in] const char* name  
Name of the entry to be deleted. Should not be NULL or empty.  


Return Values


S_OK  
Success  
E_FAIL  
Failure  
E_NOINTERFACE  
Feature or entry does not exist  
 

Example


This fragment of the code disconnects the virtual camera and deletes two previously created entries from an enumerated feature:

m_pCamera->Disconnect();  
m_pCamera->DeleteEnumEntry("TestImageSelector", "Pattern 2");  
m_pCamera->DeleteEnumEntry("TesImageSelector", "Pattern 3");  


Remarks


Use this method to delete previously created features before creating a new set of features. Note that the camera must be in the disconnected state in order for DeleteFeature to work.

This method can also be used for deleting a category created by CreateCategory.