ITokenCollection::GetToken Method

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

Syntax

HRESULT GetToken(      
    ULONG i,
    ULONG *pBegin,
    ULONG *pLength,
    LPWSTR *ppsz
);

Parameters

  • i
    [in]  The zero-based index of the desired token within the collection.
  • pBegin
    [out] Receives the zero-based starting position of the specified token, in characters. This parameter can be NULL.
  • pLength
    [out]  Receives the number of characters spanned by the token. This parameter can be NULL.
  • ppsz
    [out]  Receives the overriding text for this token if available, or NULL if there is none.

Return Value

Returns S_OK if successful, or an error value otherwise.