GetUserObjectInformation,函式。桌面對象的句柄。
基本介紹
- 中文名:GetUserObjectInformation
- 外文名:GetUserObjectInformation
- 實質:函式
- 特點:桌面對象的句柄
GetUserObjectInformation 函式
語法
BOOL WINAPI GetUserObjectInformation(
__in HANDLE hObj,
__in int nIndex,
__out_opt PVOID pvInfo,
__in DWORD nLength,
__out_opt LPDWORD lpnLengthNeeded
);
參數
hObj
視窗站或桌面對象的句柄。由CreateWindowStation、 OpenWindowStation、 CreateDesktop或OpenDesktop函式返回此句柄。
nIndex
要檢索的信息。參數可以是下列值之一。
UOI_FLAGS 句柄的標誌。PvInfo參數必須指向USEROBJECTFLAGS結構指針。
UOI_HEAPSIZE 以kb為單位的桌面堆大小,為一個ULONG值。HObj參數必須是一個桌面對象的句柄,否則,該函式將失敗。
UOI_IO 如果hObj參數是接收用戶輸入的桌面對象true,否則false。
UOI_NAME 作為字元串對象的名字。
UOI_TYPE 作為字元串對象的類型名字。
pvInfo
要接收的對象信息的緩衝區的指針。
nLength
由pvInfo參數指向的緩衝區大小,以位元組為單位。
lpnLengthNeeded
指向一個保存請求信息需要的位元組數的變數指針。當函式返回時,如果此變數的值大於nLength參數的值時,這個函式返回false,並且
沒有信息複製到pvInfo緩衝區里。如果由lpnLengthNeeded指向的變數的值大於或等於nLength的值。則複製整個信息塊。
返回值
如果函式成功,則返回值為非零值。
如果該函式失敗,則返回值為零。要獲取擴展的錯誤的信息,請調用GetLastError .
語法
BOOL WINAPI GetUserObjectInformation(
__in HANDLE hObj,
__in int nIndex,
__out_opt PVOID pvInfo,
__in DWORD nLength,
__out_opt LPDWORD lpnLengthNeeded
);
參數
hObj
視窗站或桌面對象的句柄。由CreateWindowStation、 OpenWindowStation、 CreateDesktop或OpenDesktop函式返回此句柄。
nIndex
要檢索的信息。參數可以是下列值之一。
UOI_FLAGS 句柄的標誌。PvInfo參數必須指向USEROBJECTFLAGS結構指針。
UOI_HEAPSIZE 以kb為單位的桌面堆大小,為一個ULONG值。HObj參數必須是一個桌面對象的句柄,否則,該函式將失敗。
UOI_IO 如果hObj參數是接收用戶輸入的桌面對象true,否則false。
UOI_NAME 作為字元串對象的名字。
UOI_TYPE 作為字元串對象的類型名字。
pvInfo
要接收的對象信息的緩衝區的指針。
nLength
由pvInfo參數指向的緩衝區大小,以位元組為單位。
lpnLengthNeeded
指向一個保存請求信息需要的位元組數的變數指針。當函式返回時,如果此變數的值大於nLength參數的值時,這個函式返回false,並且
沒有信息複製到pvInfo緩衝區里。如果由lpnLengthNeeded指向的變數的值大於或等於nLength的值。則複製整個信息塊。
返回值
如果函式成功,則返回值為非零值。
如果該函式失敗,則返回值為零。要獲取擴展的錯誤的信息,請調用GetLastError .