ChangeVersionComment
Called when version comment is changed.
Public Function ChangeVersionComment(
ByVal DocId As Long,
ByVal VersionNo As Single,
ByVal Comment As String) As Long
Parameters
|
In/out |
Name |
Data type |
Description |
|
In |
DocId |
Long |
Index of document with which the associated version comment is being changed |
|
In |
VersionNo |
Single |
Number of version |
|
In |
Comment |
String |
New comment that has to be set |
Description
This function is called from local and shared cabinet. It is called when any comment associated with a document are changed. The new comment that has to be set are passed in this function as a Byval parameter.
Return value
|
Name |
Description |
|
NG_SUCCESS |
In case of success |
|
-1 |
Invalid operation |
|
-2 |
Invalid operation in read only cabinet |
|
-3 |
Cabinet not connected |
Example
Dim DocId As Long
Dim VerNum As Long
Dim Comment As String
Dim lRetVal As Long
DocId = 67
VerNum = 1
Comment = “changed comment”
lRetVal=gPDb(miCurCabId). ChangeVersionComment (Byval DocId,ListIndex,ByVal VerNum,ByVal Comment)
if lRetVal <> NG_SUCCESS Then
MsgBox gPDb(miCurCabId).ErrDescription, vbInformation
Screen.MousePointer = vbNormal
Endif