IGenID::GetCounterValue Method [C++]

Article
11/12/2009

Use this method to retrieve and increment the value stored in the specified counter.

Definition

[C++]

HRESULT IGenID::GetCounterValue(BSTRbstrCounterName,
  longcDigits,
  BSTR*pbstrCounterValue);

[Visual Basic]

Function GetCounterValue(bstrCounterName As String,
  cDigits As Long) As String

Parameters

bstrCounterName[C++]
[in] A BSTR that contains the counter name.
bstrCounterName[Visual Basic]
A String that contains the counter name.
cDigits[C++]
[in] An long that contains the number of digits to return.
cDigits[Visual Basic]
A Long that contains the number of digits to return.
pbstrCounterValue[C++]
[out, retval] A pointer to a BSTR used to return the counter value.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a String that contains the counter value.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT 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, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] 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.

[C++]

The pbstrCounterValue parameter contains valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

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.

Share via