Edit

ITokenCollection::GetToken method (structuredquery.h)

  • Article

Retrieves the position, length, and any overriding string of an individual token.

Syntax

HRESULT GetToken(
  [in]  ULONG  i,
  [out] ULONG  *pBegin,
  [out] ULONG  *pLength,
  [out] LPWSTR *ppsz
);

Parameters

[in] i

Type: ULONG

The zero-based index of the desired token within the collection.

[out] pBegin

Type: ULONG*

Receives the zero-based starting position of the specified token, in characters. This parameter can be NULL.

[out] pLength

Type: ULONG*

Receives the number of characters spanned by the token. This parameter can be NULL.

[out] ppsz

Type: LPWSTR*

Receives the overriding text for this token if available, or NULL if there is none.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 with SP1 [desktop apps only]
Target Platform Windows
Header structuredquery.h
Redistributable Windows Desktop Search (WDS) 3.0