Thread32First function

Retrieves information about the first thread of any process encountered in a system snapshot.

Syntax


BOOL WINAPI Thread32First(
  _In_    HANDLE          hSnapshot,
  _Inout_ LPTHREADENTRY32 lpte
);

Parameters

hSnapshot [in]

A handle to the snapshot returned from a previous call to the CreateToolhelp32Snapshot function.

lpte [in, out]

A pointer to a THREADENTRY32 structure.

Return value

Returns TRUE if the first entry of the thread list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no threads exist or the snapshot does not contain thread information.

Remarks

The calling application must set the dwSize member of THREADENTRY32 to the size, in bytes, of the structure. Thread32First changes dwSize to the number of bytes written to the structure. This will never be greater than the initial value of dwSize, but it may be smaller. If the value is smaller, do not rely on the values of any members whose offsets are greater than this value.

To retrieve information about other threads recorded in the same snapshot, use the Thread32Next function.

Examples

For an example, see Traversing the Thread List.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

TlHelp32.h

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateToolhelp32Snapshot
Thread Walking
Thread32Next
THREADENTRY32
Tool Help Functions

 

 

Community Additions

ADD
Show: