TPUpdateDescription()

Update an ECGridID entry's Description.


      Public Function TPUpdateDescription(ByVal SessionID As String, _
                                    
      ByVal 
      ECGridID As 
      Integer, 
      _
                                    
      ByVal Description As String) 
      _
                                    
      As Boolean

Parameters

SessionID: String - GUID; The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
ECGridID: Integer; A value representing a routeable address on ECGrid. See ECGridIDs.
Description: String(3,35); The name associated with a Qualifier/ID pair.

Returns

Boolean: True if successful, false on failure.

Remarks

This allows the description associated with the ECGridID and Qualifier/ID to be changed. The system requires at least three (3) characters.

Example

Visual Basic

[insert code sample]

EventID: 3008

See Also

© 2008-2011, Loren Data Corp.
All rights reserved.

ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.