xref: /aoo4110/main/sal/inc/systools/win32/uwinapi.h (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #pragma once
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski #ifdef _UWINAPI_
27*b1cdbd2cSJim Jagielski #	define _KERNEL32_
28*b1cdbd2cSJim Jagielski #	define _USER32_
29*b1cdbd2cSJim Jagielski #	define _SHELL32_
30*b1cdbd2cSJim Jagielski #endif
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski #ifndef _WINDOWS_
33*b1cdbd2cSJim Jagielski #ifdef _MSC_VER
34*b1cdbd2cSJim Jagielski #   pragma warning(push,1) /* disable warnings within system headers */
35*b1cdbd2cSJim Jagielski #endif
36*b1cdbd2cSJim Jagielski #	include <windows.h>
37*b1cdbd2cSJim Jagielski #ifdef _MSC_VER
38*b1cdbd2cSJim Jagielski #   pragma warning(pop)
39*b1cdbd2cSJim Jagielski #endif
40*b1cdbd2cSJim Jagielski #endif
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski #ifdef __MINGW32__
43*b1cdbd2cSJim Jagielski #include <basetyps.h>
44*b1cdbd2cSJim Jagielski #ifdef _UWINAPI_
45*b1cdbd2cSJim Jagielski #define WINBASEAPI
46*b1cdbd2cSJim Jagielski #endif
47*b1cdbd2cSJim Jagielski #endif
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski /**	GetUserDomain
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski The GetUserDomain function retrieves the name of the NT domain the user	is
52*b1cdbd2cSJim Jagielski logged in.
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski Parameters
55*b1cdbd2cSJim Jagielski 	@param lpBuffer
56*b1cdbd2cSJim Jagielski 		[out] Pointer to a buffer that receives a null-terminated string
57*b1cdbd2cSJim Jagielski 		containing the domain name.
58*b1cdbd2cSJim Jagielski 	@param nBufferSize
59*b1cdbd2cSJim Jagielski 		[in] Specifies the size, in TCHARs, of the buffer pointed to
60*b1cdbd2cSJim Jagielski 		by the lpBuffer parameter.
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski 
63*b1cdbd2cSJim Jagielski Return Values
64*b1cdbd2cSJim Jagielski 	@return
65*b1cdbd2cSJim Jagielski 	If the function succeeds, the return value is the number of TCHARs stored
66*b1cdbd2cSJim Jagielski 	into the buffer pointed to by lpBuffer, not including the terminating
67*b1cdbd2cSJim Jagielski 	null character.
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski 	If the domain name can't be retrieved, the return value is zero.
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski 	If the buffer pointed to by lpBuffer is not large enough, the return value
72*b1cdbd2cSJim Jagielski 	is the buffer size, in TCHARs, required to hold the value string and its
73*b1cdbd2cSJim Jagielski 	terminating null character.
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski Remarks
76*b1cdbd2cSJim Jagielski 	Windows 95/98/Me: If the user is not logged in onto a NT domain server
77*b1cdbd2cSJim Jagielski 	the name of the workgroup is returned.
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski Requirements
80*b1cdbd2cSJim Jagielski   Windows NT/2000/XP: Included in Windows NT 4 and later.
81*b1cdbd2cSJim Jagielski   Windows 95/98/Me: Included in Windows 95 and later.
82*b1cdbd2cSJim Jagielski   Header: Declared in Uwinapi.h; include Uwinapi.h.
83*b1cdbd2cSJim Jagielski   Library: Use Uwinapi.lib.
84*b1cdbd2cSJim Jagielski   Unicode: Implemented as Unicode and ANSI versions on Windows 95/98/Me/NT/2000/XP.
85*b1cdbd2cSJim Jagielski 
86*b1cdbd2cSJim Jagielski See Also
87*b1cdbd2cSJim Jagielski @see
88*b1cdbd2cSJim Jagielski */
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski EXTERN_C WINBASEAPI DWORD WINAPI GetUserDomainA( LPSTR lpBuffer, DWORD nBuffserSize );
91*b1cdbd2cSJim Jagielski EXTERN_C WINBASEAPI DWORD WINAPI GetUserDomainW( LPWSTR lpBuffer, DWORD nBuffserSize );
92*b1cdbd2cSJim Jagielski 
93*b1cdbd2cSJim Jagielski #ifdef UNICODE
94*b1cdbd2cSJim Jagielski #define GetUserDomain	GetUserDomainW
95*b1cdbd2cSJim Jagielski #else
96*b1cdbd2cSJim Jagielski #define GetUserDomain	GetUserDomainA
97*b1cdbd2cSJim Jagielski #endif
98*b1cdbd2cSJim Jagielski 
99*b1cdbd2cSJim Jagielski EXTERN_C WINBASEAPI DWORD WINAPI GetProcessId( HANDLE hProcess );
100*b1cdbd2cSJim Jagielski 
101*b1cdbd2cSJim Jagielski /* macro that calculates the count of elements of a static array */
102*b1cdbd2cSJim Jagielski 
103*b1cdbd2cSJim Jagielski #define elementsof(buf)	(sizeof(buf) / sizeof((buf)[0]))
104*b1cdbd2cSJim Jagielski 
105*b1cdbd2cSJim Jagielski #ifdef __cplusplus
106*b1cdbd2cSJim Jagielski 
IsValidHandle(HANDLE handle)107*b1cdbd2cSJim Jagielski inline bool IsValidHandle(HANDLE handle)
108*b1cdbd2cSJim Jagielski {
109*b1cdbd2cSJim Jagielski 	return	handle != INVALID_HANDLE_VALUE && handle != NULL;
110*b1cdbd2cSJim Jagielski }
111*b1cdbd2cSJim Jagielski 
112*b1cdbd2cSJim Jagielski #else	/* __cplusplus */
113*b1cdbd2cSJim Jagielski 
114*b1cdbd2cSJim Jagielski #define IsValidHandle(Handle)	((DWORD)(Handle) + 1 > 1)
115*b1cdbd2cSJim Jagielski 
116*b1cdbd2cSJim Jagielski #endif	/* __cplusplus */
117*b1cdbd2cSJim Jagielski 
118