ITfCandidateList::GetCandidate method
Syntax
HRESULT GetCandidate(
[in] ULONG nIndex,
[out] ITfCandidateString **ppCand
);
Parameters
- nIndex [in]
-
Specifies the zero-based index of the candidate string to obtain.
- ppCand [out]
-
Pointer to an ITfCandidateString interface pointer that receives the candidate string object. The caller must release this interface when it is no longer required.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful. |
|
nIndex is invalid. |
|
ppCand is invalid. |
|
A memory allocation failure occurred. |
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps | Windows Store apps] |
|
Redistributable |
TSF 1.0 on Windows 2000 Professional |
|
Header |
|
|
IDL |
|
|
DLL |
|
See also