IEnumCERTVIEWCOLUMN::Skip method (certview.h)

Article
02/22/2024

The Skip method skips a specified number of columns in the column-enumeration sequence.

Syntax

HRESULT Skip(
  [in] LONG celt
);

Parameters

[in] celt

The number of columns to skip. A positive value for the celt parameter causes the column-enumeration sequence to skip forward in the enumeration sequence. A negative value causes column-enumeration to skip backward in the enumeration sequence.

Return value

VB

If the method succeeds, the method returns S_OK.

A return value of E_INVALIDARG indicates that a negative value in the celt parameter caused the column-enumeration sequence index to become less than zero.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

Remarks

Upon successful completion of this function, call the IEnumCERTVIEWCOLUMN::Next method to reference the current column in the column-enumeration sequence. After this second call is made, the information in the column can be obtained by calling one of the following methods:

IEnumCERTVIEWCOLUMN::GetName: Retrieves the nonlocalized name of the column.
IEnumCERTVIEWCOLUMN::GetDisplayName: Retrieves the localized name of the column.
IEnumCERTVIEWCOLUMN::GetValue: Retrieves the data in the column.
IEnumCERTVIEWCOLUMN::GetType: Retrieves the type of data in the column.
IEnumCERTVIEWCOLUMN::GetMaxLength: Retrieves the maximum length, in bytes, of the column.

The column-enumeration sequence maintains an internal zero-based index. The call to the Skip method causes this index to increase or decrease based on the setting of the celt parameter.

If a negative value of the celt parameter causes the index to be less than zero, the behavior of subsequent calls to Next is undefined.

If a positive value of the celt parameter causes the index to exceed the last row in the enumeration sequence, a subsequent call to the Next method will fail.

Examples

HRESULT  hr;
LONG     Index;

// pEnumCol is previously instantiated IEnumCERTVIEWCOLUMN object
// skip the next five columns
hr = pEnumCol->Skip(5);
if (S_OK == hr) 
{
    // get the next column
    hr = pEnumCol->Next(&Index);
    if (S_OK == hr)
    {
        // Use this column as needed.
    }
}

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	certview.h (include Certsrv.h)
Library	Certidl.lib
DLL	Certadm.dll

Share via