SetUserDefinedName

Description

Sets the user-defined name for the virtual camera.

[C++]
int SetUserDefinedName(const char* userDefined);


Parameters [C/C++]

[in] const char* userDefined

    String specifying the user-defined name of the virtual camera device.

Return Values

S_OK

Success

E_FAIL

Failure

Example

This fragment of code sets the device information fields and assigns a user-defined name:

      m_pCamera->SetDeviceInfo("gigecam","simulator", "v.2.5", "GigE Vision Camera Emulator", "00000-01");

m_pCamera->SetUserDefinedName("Cam001");

Remarks

Per GigE Vision specifications, the user-defined name is broadcast as part of the Discovery acknowledgement message along with the model name and other device information fields.

This method can be used in both connected and disconnected states of the camera.

For GenICam SFNC compliance it is recommended to have user defined name linked to the value of the DeviceUserID feature.