GetUserObjectInformation
The GetUserObjectInformation
function returns information about a window station or desktop object.
BOOL GetUserObjectInformation(
|
HANDLE hObj, |
// handle of object
to get information for |
|
int nIndex, |
// type of
information to get |
|
PVOID pvInfo, |
// points to buffer
that receives the information |
|
DWORD nLength, |
// size, in bytes,
of pvInfo buffer |
|
LPDWORD lpnLengthNeeded |
// receives
required size, in bytes, of pvInfo buffer |
|
); |
|
Parameters
hObj
Identifies
the window station or desktop object for which to return information. This can
be an HDESK or HWINSTA handle (for example, a handle returned by CreateWindowStation, OpenWindowStation, CreateDesktop, or OpenDesktop).
nIndex
Specifies the
object information to be retrieved. The parameter must be one of the following
values:
|
Value |
Description |
|
UOI_FLAGS |
Returns
handle flags. The pvInfo parameter must point to a USEROBJECTFLAGS structure. |
|
UOI_NAME |
Returns a
string containing the name of the object. |
|
UOI_TYPE |
Returns a
string containing the type name of the object. |
pvInfo
Points to a
buffer to receive the object information.
nLength
Specifies the
size, in bytes, of the buffer pointed to by the pvInfo parameter.
lpnLengthNeeded
Points to a
variable receiving the number of bytes required to store the requested
information. If this variable s value is greater than the value of the nLength
parameter when the function returns, the function returns FALSE, and none of
the information is copied to the pvInfo buffer. If the value of the
variable pointed to by lpnLengthNeeded is less than or equal to the
value of nLength, the entire information block is copied.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
See Also