processthreadsapi.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_STARTUPINFOA
struct	_STARTUPINFOW
struct	_PROCESS_INFORMATION

Typedefs
typedef struct _STARTUPINFOA	STARTUPINFOA
typedef struct _STARTUPINFOA *	LPSTARTUPINFOA
typedef struct _STARTUPINFOW	STARTUPINFOW
typedef struct _STARTUPINFOW *	LPSTARTUPINFOW
typedef STARTUPINFOA	STARTUPINFO
typedef STARTUPINFOA *	LPSTARTUPINFO
typedef struct _PROCESS_INFORMATION	PROCESS_INFORMATION
typedef struct _PROCESS_INFORMATION *	PPROCESS_INFORMATION
typedef struct _PROCESS_INFORMATION *	LPPROCESS_INFORMATION
typedef struct _PROC_THREAD_ATTRIBUTE_LIST *	PPROC_THREAD_ATTRIBUTE_LIST
typedef struct _PROC_THREAD_ATTRIBUTE_LIST *	LPPROC_THREAD_ATTRIBUTE_LIST
typedef enum _PROCESS_INFORMATION_CLASS	PROCESS_INFORMATION_CLASS

Enumerations
enum	_PROCESS_INFORMATION_CLASS {   ProcessMemoryPriority , ProcessMemoryExhaustionInfo , ProcessAppMemoryInfo , ProcessInPrivateInfo ,   ProcessPowerThrottling , ProcessReservedValue1 , ProcessTelemetryCoverageInfo , ProcessProtectionLevelInfo ,   ProcessLeapSecondInfo , ProcessMachineTypeInfo , ProcessOverrideSubsequentPrefetchParameter , ProcessMaxOverridePrefetchParameter ,   ProcessInformationClassMax }

Functions
WINBASEAPI HRESULT WINAPI	GetThreadDescription (_In_ HANDLE hThread, _Outptr_result_z_ PWSTR *ppszThreadDescription)
WINBASEAPI HRESULT WINAPI	SetThreadDescription (_In_ HANDLE hThread, _In_ PCWSTR lpThreadDescription)
WINBASEAPI BOOL WINAPI	SetThreadStackGuarantee (_Inout_ PULONG StackSizeInBytes)

Typedef Documentation

LPPROC_THREAD_ATTRIBUTE_LIST

typedef struct _PROC_THREAD_ATTRIBUTE_LIST * LPPROC_THREAD_ATTRIBUTE_LIST

Definition at line 72 of file processthreadsapi.h.

LPPROCESS_INFORMATION

typedef struct _PROCESS_INFORMATION* LPPROCESS_INFORMATION

LPSTARTUPINFO

typedef STARTUPINFOA * LPSTARTUPINFO

Definition at line 61 of file processthreadsapi.h.

LPSTARTUPINFOA

typedef struct _STARTUPINFOA * LPSTARTUPINFOA

LPSTARTUPINFOW

typedef struct _STARTUPINFOW* LPSTARTUPINFOW

PPROC_THREAD_ATTRIBUTE_LIST

typedef struct _PROC_THREAD_ATTRIBUTE_LIST* PPROC_THREAD_ATTRIBUTE_LIST

Definition at line 72 of file processthreadsapi.h.

PPROCESS_INFORMATION

typedef struct _PROCESS_INFORMATION* PPROCESS_INFORMATION

PROCESS_INFORMATION

typedef struct _PROCESS_INFORMATION PROCESS_INFORMATION

PROCESS_INFORMATION_CLASS

typedef enum _PROCESS_INFORMATION_CLASS PROCESS_INFORMATION_CLASS

STARTUPINFO

typedef STARTUPINFOA STARTUPINFO

Definition at line 61 of file processthreadsapi.h.

STARTUPINFOA

typedef struct _STARTUPINFOA STARTUPINFOA

STARTUPINFOW

typedef struct _STARTUPINFOW STARTUPINFOW

Enumeration Type Documentation

_PROCESS_INFORMATION_CLASS

enum _PROCESS_INFORMATION_CLASS

Enumerator
ProcessMemoryPriority
ProcessMemoryExhaustionInfo
ProcessAppMemoryInfo
ProcessInPrivateInfo
ProcessPowerThrottling
ProcessReservedValue1
ProcessTelemetryCoverageInfo
ProcessProtectionLevelInfo
ProcessLeapSecondInfo
ProcessMachineTypeInfo
ProcessOverrideSubsequentPrefetchParameter
ProcessMaxOverridePrefetchParameter
ProcessInformationClassMax

Definition at line 160 of file processthreadsapi.h.

{
    ProcessMemoryPriority,
    ProcessMemoryExhaustionInfo,
    ProcessAppMemoryInfo,
    ProcessInPrivateInfo,
    ProcessPowerThrottling,
    ProcessReservedValue1,  // Formerly ProcessActivityThrottlePolicyInfo
    ProcessTelemetryCoverageInfo,
    ProcessProtectionLevelInfo,
    ProcessLeapSecondInfo,
    ProcessMachineTypeInfo,
    ProcessOverrideSubsequentPrefetchParameter,
    ProcessMaxOverridePrefetchParameter,
    ProcessInformationClassMax
} PROCESS_INFORMATION_CLASS;

Function Documentation

GetThreadDescription()

WINBASEAPI HRESULT WINAPI GetThreadDescription	(	_In_ HANDLE	hThread,
		_Outptr_result_z_ PWSTR *	ppszThreadDescription
	)

Definition at line 13 of file ThreadDescription.c.

{
    PTHREAD_NAME_INFORMATION NameInfo = NULL;
    PVOID ptr;
    NTSTATUS Status;
    ULONG Length;
 
    *ppszThreadDescription = NULL;
 
    /* Since there may be concurrent SetThreadDescription() invocations being
     * executed, we need to loop over the buffer allocation size until we can
     * successfully capture the thread name. */
    Length = 0;
    Status = NtQueryInformationThread(hThread, ThreadNameInformation, NULL, 0, &Length);
    if (Status != STATUS_BUFFER_TOO_SMALL)
        return HRESULT_FROM_NT(Status);
 
    /* Loop again only if we get buffer-too-small types of errors;
     * otherwise, break the loop: any error will be handled below. */
    while (Status == STATUS_INFO_LENGTH_MISMATCH ||
           Status == STATUS_BUFFER_TOO_SMALL)
    {
        /* (Re-)allocate the information buffer */
        ptr = (NameInfo ? LocalReAlloc(NameInfo, Length, LMEM_MOVEABLE)
                        : LocalAlloc(LMEM_FIXED, Length));
        if (!ptr)
        {
            Status = STATUS_NO_MEMORY;
            break;
        }
        NameInfo = ptr;
        Status = NtQueryInformationThread(hThread, ThreadNameInformation,
                                          NameInfo, Length, &Length);
    }
    if (!NT_SUCCESS(Status))
    {
        LocalFree(NameInfo);
        return HRESULT_FROM_NT(Status);
    }
 
    /*
     * We already have a suitable memory buffer, containing a UNICODE_STRING
     * followed by the actual string data. Just move the string back to the
     * beginning of the buffer and resize it down. Since sizeof(UNICODE_STRING)
     * is larger than sizeof(WCHAR), we also have space for the NUL-terminator.
     */
    *ppszThreadDescription = (PWSTR)NameInfo;
    Length = NameInfo->ThreadName.Length;
    if (Length)
        RtlMoveMemory(*ppszThreadDescription, NameInfo->ThreadName.Buffer, Length);
    (*ppszThreadDescription)[Length / sizeof(WCHAR)] = UNICODE_NULL;
 
    /* Resize down the buffer. If the call fails, the old buffer
     * is still valid, but is larger than what is necessary. */
    ptr = LocalReAlloc(*ppszThreadDescription, Length + sizeof(WCHAR), LMEM_FIXED);
    if (ptr)
        *ppszThreadDescription = ptr;
 
    return HRESULT_FROM_NT(Status);
}

SetThreadDescription()

WINBASEAPI HRESULT WINAPI SetThreadDescription	(	_In_ HANDLE	hThread,
		_In_ PCWSTR	lpThreadDescription
	)

Definition at line 79 of file ThreadDescription.c.

{
    THREAD_NAME_INFORMATION NameInfo;
    NTSTATUS Status;
 
    Status = RtlInitUnicodeStringEx(&NameInfo.ThreadName, lpThreadDescription);
    if (NT_SUCCESS(Status))
    {
        Status = NtSetInformationThread(hThread, ThreadNameInformation,
                                        &NameInfo, sizeof(NameInfo));
    }
    return HRESULT_FROM_NT(Status);
}

Referenced by rpcrt4_http_timer_thread(), RPCRT4_io_thread(), and RPCRT4_server_thread().

SetThreadStackGuarantee()

WINBASEAPI BOOL WINAPI SetThreadStackGuarantee

(

_Inout_ PULONG

StackSizeInBytes

)