GenID.GetCounterValue
.gif "Ee825793.c++_on(en-US,CS.10).gif")
.gif "Ee825793.vb_off(en-US,CS.10).gif")
Use this method to retrieve and increment the value stored in the specified counter.
Definition
Function GetCounterValue(bstrCounterName As String,cDigits As Long) As String
Parameters
bstrCounterName
A String that contains the counter name.
cDigits
A Long that contains the number of digits to return.
Return Values
If this method completes successfully, it returns a String that contains the counter value.
Error Values
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
After the current value of the counter is returned, the counter is incremented by one. Use the InitializeCounter method to reset the counter.
If the value of the counter is less than the number of digits requested, the value is left padded with zeroes.
The Initialize method must be called before calling the GetCounterValue method.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' sCounterValue is a String
' oGenID is a Commerce GenID object
' The value stored in the counter is 285.
sCounterValue = oGenID.GetCounterValue("OrderIDCounter", 4)
' sCounterValue = 0285
' The value now stored in the OrderIDCounter is 286.