Id Property
Id Property |
Gets the identifier of an object.
Declaration
[C++]
[propget] HRESULT get_Id ([out, retval] long* Id);
[propget] HRESULT get_Id ([out, retval] BSTR* Id);
[propget] HRESULT get_Id ([out, retval] InkApplicationGesture* Id);
[Microsoft® Visual Basic® 6.0]
Public Property Get Id() As Long
Public Property Get Id() As InkApplicationGesture
Public Property Get Id() As String
Property Value
long/BSTR/InkApplicationGesture Returns an identifier for the object.
This property is read-only.
For more information about the BSTR data type, see Using the Automation Library.
Return Value
| HRESULT value | Description |
|---|---|
| S_OK | Success. |
| E_INKEXCEPTION | An exception occurred while processing. |
| E_POINTER | The parameter is an invalid pointer. |
| E_FAIL | An unspecified error occurred. |
| E_UNEXPECTED | Unexpected parameter or property type. |
Remarks
Note: An object's identifier is constant over time, meaning that it never changes.
The following table describes the return type for each object that provides an Id property.
| Object | Return Type |
|---|---|
| IInkCursor | Long |
| IInkCursorButton | String/BSTR |
| IInkExtendedProperty | String/BSTR |
| IInkGesture | InkApplicationGesture |
| IInkStrokeDisp | Long |
Note: For the IInkExtendedProperty object, use the Guid property.
This property is read only.
Example
[Visual Basic 6.0]
This Visual Basic 6.0 example returns the ID of a stroke.
Dim theStrokeID As Long
theStrokeID = theInkCollector.Ink.Strokes(0).Id