Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Allows the comLU0 client to set property values for a session.
Syntax
void SetProperty(
string PropertyName,
ref object value)
Parameters
| Parameter | Description |
|---|---|
PropertyName |
The name of the property to be added or updated. |
Value |
The value of the specified property. |
Return Value
| Value | Description |
|---|---|
| S_OK | The requested property was added successfully. |
| CLU0_S_PROP_UPDATED | The existing property specified was updated successfully |
| CLU0_E_NOT_CONNECTED | The comLU0 client object is not connected to a session object through a call to the IcomLU0.Connect method. |
| CLU0_E_SERVER_FAILURE | The TSS session is no longer valid. You should release the session handle. |
| CLU0_E_WAITING | Another thread has issued a Receive call for the specified comLU0 method which has not yet returned. |
| CLU0_E_BADPARAM | The specified property is a pre-defined session property, and therefore could not be updated. |
Remarks
Property names are case-insensitive.
You cannot use SetProperty to modify any of the predefined connection properties. Instead, you can change only the properties defined with CreateSession.