|
42
|
1 <?xml version="1.0"?>
|
|
|
2 <doc>
|
|
|
3 <assembly>
|
|
|
4 <name>JetBrains.Platform.Symbols.Interop.WinApi</name>
|
|
|
5 </assembly>
|
|
|
6 <members>
|
|
|
7 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MsoConstants">
|
|
|
8 <summary>
|
|
|
9 Contants used by Component API Interfaces (IMsoComponent and IMsoComponentManager).
|
|
|
10 </summary>
|
|
|
11 <remarks>
|
|
|
12 The constants are taken from: System.Windows.Forms.NativeMethods.MSOCM, Assembly: System.Windows.Forms, Version=4.0.0.0
|
|
|
13 </remarks>
|
|
|
14 </member>
|
|
|
15 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF">
|
|
|
16 <summary>
|
|
|
17 MSO component registration flags.
|
|
|
18 </summary>
|
|
|
19 <remarks>
|
|
|
20 Used by OLECRINFO.grfcrf field passed to IOleComponentManager.FRegisterComponent method and its equivalent in the OLE-world IMsoComponentManager and MSOCRINFO structure.
|
|
|
21 </remarks>
|
|
|
22 </member>
|
|
|
23 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfNeedIdleTime">
|
|
|
24 <summary>
|
|
|
25 Component needs idle time.
|
|
|
26 </summary>
|
|
|
27 </member>
|
|
|
28 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfNeedPeriodicIdleTime">
|
|
|
29 <summary>
|
|
|
30 Component needs idle time every N milliseconds.
|
|
|
31 </summary>
|
|
|
32 </member>
|
|
|
33 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfPreTranslateKeys">
|
|
|
34 <summary>
|
|
|
35 Component must process keyboard messages before translation.
|
|
|
36 </summary>
|
|
|
37 </member>
|
|
|
38 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfPreTranslateAll">
|
|
|
39 <summary>
|
|
|
40 Component must process all messages before translation.
|
|
|
41 </summary>
|
|
|
42 </member>
|
|
|
43 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfNeedSpecActiveNotifs">
|
|
|
44 <summary>
|
|
|
45 Component needs to be notified for special activation changes.
|
|
|
46 Currently, this will notify component if ExclusiveBorderSpace or ExclusiveActivation mode changes.
|
|
|
47 Top-level components should reg this flag.
|
|
|
48 </summary>
|
|
|
49 </member>
|
|
|
50 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfNeedAllActiveNotifs">
|
|
|
51 <summary>
|
|
|
52 Component needs to be notified for every change in activation state
|
|
|
53 </summary>
|
|
|
54 </member>
|
|
|
55 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfExclusiveBorderSpace">
|
|
|
56 <summary>
|
|
|
57 Component needs exclusive border space when active (normally only used by TopLevel Mac components).
|
|
|
58 </summary>
|
|
|
59 </member>
|
|
|
60 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfExclusiveActivation">
|
|
|
61 <summary>
|
|
|
62 Component becomes exclusively active when activated
|
|
|
63 </summary>
|
|
|
64 </member>
|
|
|
65 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfNeedAllMacEvents">
|
|
|
66 <summary>
|
|
|
67 Component needs all mac events
|
|
|
68 </summary>
|
|
|
69 </member>
|
|
|
70 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MSOCRF.msocrfMaster">
|
|
|
71 <summary>
|
|
|
72 Component is always active and gets first shot at evrything (Mac?)
|
|
|
73 </summary>
|
|
|
74 </member>
|
|
|
75 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.OLECADVF">
|
|
|
76 <summary>
|
|
|
77 OLE component registration advise flags (see msocstate enumeration).
|
|
|
78 </summary>
|
|
|
79 </member>
|
|
|
80 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.OLECRF">
|
|
|
81 <summary>
|
|
|
82 Component registration flags.
|
|
|
83 </summary>
|
|
|
84 <remarks>Used by OLECRINFO.grfcrf field passed to IOleComponentManager.FRegisterComponent method and its equivalent in the OLE-world IMsoComponentManager and MSOCRINFO structure.
|
|
|
85 </remarks>
|
|
|
86 <seealso cref="!:Microsoft.VisualStudio.OLE.Interop._OLECRF"/>
|
|
|
87 </member>
|
|
|
88 <member name="T:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent">
|
|
|
89 <summary>
|
|
|
90 Provides components that need idle time, such as packages that manage modeless top-level windows, with access to the message loop and other facilities.
|
|
|
91 </summary>
|
|
|
92 <remarks>
|
|
|
93 Register the interface with the component manager that implements the IMsoComponentManager interface.
|
|
|
94
|
|
|
95 The interface declarartion is taken from type: System.Windows.Forms.UnsafeNativeMethods, Assembly: System.Windows.Forms, Version=4.0.0.0
|
|
|
96 </remarks>
|
|
|
97 </member>
|
|
|
98 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.FDebugMessage(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)">
|
|
|
99 <summary>
|
|
|
100 This method is reserved for internal use and is not intended to be used in your code. This method always returns TRUE.
|
|
|
101 </summary>
|
|
|
102 <remarks>
|
|
|
103 In Microsoft.VisualStudio.OLE.Interop.IOleComponent inerface this method is called FReserved1.
|
|
|
104 </remarks>
|
|
|
105 BOOL FDebugMessage(HANDLE hinst, UINT message, WPARAM wParam, LPARAM lParam);
|
|
|
106 </member>
|
|
|
107 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.FPreTranslateMessage(JetBrains.Interop.WinApi.MSG@)">
|
|
|
108 <summary>
|
|
|
109 Enables components to process a message before the message is translated and is dispatched.
|
|
|
110 </summary>
|
|
|
111 <returns>TRUE to indicate that the message is consumed; otherwise, FALSE</returns>
|
|
|
112 <remarks>
|
|
|
113 Components can use the TranslateAccelerator function, use the IsDialogMessage function, modify the pMsg parameter, or take some other action.
|
|
|
114 </remarks>
|
|
|
115 </member>
|
|
|
116 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.OnEnterState(System.Int32,System.Boolean)">
|
|
|
117 <summary>
|
|
|
118 Notifies a component when the application enters or exits the state specified by the uStateId parameter.
|
|
|
119 </summary>
|
|
|
120 <remarks>
|
|
|
121 The component should take action depending on the value of the uStateId parameter as specified in Msocstate (TODO) enumeration.
|
|
|
122
|
|
|
123 If n calls are made with the fEnter parameter equal to TRUE, the component should consider the state to be in effect
|
|
|
124 until n calls are made with the fEnter parameter equal to FALSE.
|
|
|
125
|
|
|
126 It is possible for this method to be called with the fEnter parameter equal to FALSE more times than it was called with TRUE.
|
|
|
127 The counter should not be decremented for FALSE if it is already at 0.
|
|
|
128 </remarks>
|
|
|
129 </member>
|
|
|
130 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.OnAppActivate(System.Boolean,System.Int32)">
|
|
|
131 <summary>
|
|
|
132 Notifies the component when the host application gains or loses activation.
|
|
|
133 </summary>
|
|
|
134 </member>
|
|
|
135 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.OnLoseActivation">
|
|
|
136 <summary>
|
|
|
137 Notifies the active component that it has lost its active status because the host or another component has become active.
|
|
|
138 </summary>
|
|
|
139 </member>
|
|
|
140 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.OnActivationChange(JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent,System.Boolean,System.Int32,System.Boolean,System.Int32,System.Int32)">
|
|
|
141 <summary>
|
|
|
142 Notifies the component when a new object is being activated.
|
|
|
143 </summary>
|
|
|
144 <param name="component">A pointer to the component being activated. Can be NULL.</param>
|
|
|
145 <param name="fSameComponent">TRUE to indicate that the component parameter is the same component registration as the component that this method is being called on; otherwise, FALSE.</param>
|
|
|
146 <param name="pcrinfo">A pointer to an MSOCRINFO structure that specifies the active component’s registration information. Can be NULL.</param>
|
|
|
147 <param name="fHostIsActivating">TRUE to indicate that the host object is being activated; otherwise, FALSE.
|
|
|
148 If the fHostIsActivating parameter is TRUE and the component parameter is NULL, the host object is being activated.
|
|
|
149 If the fHostIsActivating parameter is FALSE and the component parameter is NULL, there is no current active object</param>
|
|
|
150 <param name="pchostinfo">A pointer to an MSOCHOSTINFO structure that specifies the host component's information. Can be NULL.</param>
|
|
|
151 <param name="dwReserved">Reserved for future use. Should be 0.</param>
|
|
|
152 </member>
|
|
|
153 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.FDoIdle(System.Int32)">
|
|
|
154 <summary>
|
|
|
155 Enables the component to do idle-time tasks.
|
|
|
156 </summary>
|
|
|
157 <param name="grfidlef">The type of idle-time tasks to perform. The type of tasks are specified by a combination of the values of the following flags:
|
|
|
158 msoidlefPeriodic = 1 Specifies to perform periodic idle-time tasks.
|
|
|
159 msoidlefNonPeriodic = 2 Specifies to perform any nonperiodic idle-time tasks.
|
|
|
160 msoidlefPriority = 4 Specifies to perform high priority, nonperiodic idle-time tasks.
|
|
|
161 msoidlefAll = 0xFFFFFFFF Specifies to perform all idle-time tasks.</param>
|
|
|
162 <returns>TRUE to indicate that more time is needed to perform the idle-time tasks; otherwise, FALSE.</returns>
|
|
|
163 <remarks>
|
|
|
164 The component may periodically call the IMsoComponentManager::FContinueIdle method.
|
|
|
165 If the FContinueIdle method returns FALSE, the component should terminate its idle-time processing and return.
|
|
|
166 If a component reaches a point where it has no idle-time tasks and does not need IMsoComponent::FDoIdle method calls,
|
|
|
167 it should remove its idle task registration by calling the IMsoComponentManager::FUpdateComponentRegistration method.
|
|
|
168 If this method is called while the component is performing a tracking operation,
|
|
|
169 the component should perform only idle-time tasks that are appropriate to perform during tracking.
|
|
|
170 </remarks>
|
|
|
171 </member>
|
|
|
172 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.FContinueMessageLoop(System.Int32,System.Int32,JetBrains.Interop.WinApi.MSG[])">
|
|
|
173 <summary>
|
|
|
174 Indicates whether the message loop pushed by the component should continue.
|
|
|
175 </summary>
|
|
|
176 <param name="uReason">Specifies the reason the message loop is being pushed. For more information, see the Msoloop (TODO) enumeration.</param>
|
|
|
177 <param name="pvLoopData">The component's private data.</param>
|
|
|
178 <param name="pMsgPeeked">A pointer to the next message in the queue. This parameter is NULL if there are no more messages in the queue.</param>
|
|
|
179 <returns>TRUE to indicate that the message loop should continue; otherwise, FALSE.</returns>
|
|
|
180 <remarks>
|
|
|
181 This method is called after peeking the next message in the queue (by calling the PeekMessage function) but before the message is removed from the queue.
|
|
|
182 The peeked message is passed in the pMsgPeeked parameter. This method may be called again when the next message has already been removed from the queue,
|
|
|
183 in which case the pMsgPeeked parameter is NULL.
|
|
|
184 If this method returns FALSE, the component manager terminates the loop without removing from the queue the message specified by the pMsgPeeked parameter.
|
|
|
185 </remarks>
|
|
|
186 </member>
|
|
|
187 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.FQueryTerminate(System.Boolean)">
|
|
|
188 <summary>
|
|
|
189 Specifies whether the component can terminate.
|
|
|
190 </summary>
|
|
|
191 <param name="fPromptUser">TRUE to indicate that the component might need to prompt the user; otherwise, FALSE.</param>
|
|
|
192 <returns>TRUE if the component can terminate; otherwise, FALSE.</returns>
|
|
|
193 <remarks>
|
|
|
194 This method is called by the component manager to determine whether the component is in a state in which it can terminate.
|
|
|
195
|
|
|
196 If fPromptUser is TRUE, the component may query the user, as appropriate, to determine whether it should terminate.
|
|
|
197 If it cannot terminate, it should inform the user of why it cannot terminate.
|
|
|
198 If fPromptUser is FALSE, the component should make its decision without querying or informing the user.
|
|
|
199 </remarks>
|
|
|
200 </member>
|
|
|
201 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.Terminate">
|
|
|
202 <summary>
|
|
|
203 Terminates the registration of the IMsoComponent interface.
|
|
|
204 </summary>
|
|
|
205 <remarks>
|
|
|
206 The IMsoComponent interface should revoke its registration with the component manager, release references to the component manager, and then perform any necessary cleanup.
|
|
|
207 </remarks>
|
|
|
208 </member>
|
|
|
209 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponent.HwndGetWindow(System.Int32,System.Int32)">
|
|
|
210 <summary>
|
|
|
211 Retrieves a window that is associated with the component.
|
|
|
212 </summary>
|
|
|
213 <param name="dwWhich">The window for which to obtain the window handle (HWND). The possible values are:
|
|
|
214 msocWindowFrameToplevel = 0 Specifies the top frame window.
|
|
|
215 Multiple-document interface (MDI) applications should return the MDI frame (not the MDI client) or the application frame window.
|
|
|
216 Single-document interface (SDI) applications should return the frame window that hosts the component.
|
|
|
217 This should be the topmost window that owns the component.
|
|
|
218 msocWindowFrameOwner = 1 Specifies the window that owns the component.
|
|
|
219 The window may be the same as the top frame window, or may be an owned window of the top frame window.
|
|
|
220 msocWindowComponent = 2 Specifies the main window of the component.
|
|
|
221 msocWindowDlgOwner = 3 Specifies that the caller needs to display a dialog box to be owned by the component.
|
|
|
222 The component should return a window that is suitable for use as the dialog box's owner window.</param>
|
|
|
223 <param name="dwReserved">Reserved for future use. Should be 0.</param>
|
|
|
224 <returns>The handle to the window associated with the component. If this method fails or the window does not exist, NULL is returned.</returns>
|
|
|
225 </member>
|
|
|
226 <member name="T:JetBrains.Interop.WinApi.Declarations.Interfaces.IMsoComponentManager">
|
|
|
227 <summary>
|
|
|
228 Defines a component manager, which is an object that coordinates other components by using its message loop for message processing and allocation of idle time.
|
|
|
229 </summary>
|
|
|
230 <remarks>
|
|
|
231 You can get an instance of this interface by calling the CoRegisterMessageFilter function to get a reference to the current message filter.
|
|
|
232 Ensure that you immediately call the CoRegisterMessageFilter function again to put the object back right away.
|
|
|
233 Then call the QueryInterface method on the returned message filter to get an IServiceProvider interface.
|
|
|
234 Finally, call the QueryService method on the IServiceProvider interface to get an IMsoComponentManager interface.
|
|
|
235
|
|
|
236 The interface declarartion is taken from type: System.Windows.Forms.UnsafeNativeMethods, Assembly: System.Windows.Forms, Version=4.0.0.0
|
|
|
237 </remarks>
|
|
|
238 </member>
|
|
|
239 <member name="T:JetBrains.Interop.WinApi.MSOCRINFO">
|
|
|
240 <summary>
|
|
|
241 Specifies registration information for a MSO component.
|
|
|
242 </summary>
|
|
|
243 </member>
|
|
|
244 <member name="F:JetBrains.Interop.WinApi.MSOCRINFO.cbSize">
|
|
|
245 <summary>
|
|
|
246 The size, in bytes, of the MSOCRINFO structure.
|
|
|
247 </summary>
|
|
|
248 </member>
|
|
|
249 <member name="F:JetBrains.Interop.WinApi.MSOCRINFO.uIdleTimeInterval">
|
|
|
250 <summary>
|
|
|
251 The interval time, in milliseconds, of when a periodic idle phase should occur. During the idle phase, the component needs to perform idle-time tasks.
|
|
|
252 This member applies only if the msocrfNeedPeriodicIdleTime bit flag is registered in the grfcrf member
|
|
|
253 </summary>
|
|
|
254 </member>
|
|
|
255 <member name="F:JetBrains.Interop.WinApi.MSOCRINFO.grfcrf">
|
|
|
256 <summary>
|
|
|
257 Bit flags composed from the Msocrf enumeration.
|
|
|
258 </summary>
|
|
|
259 </member>
|
|
|
260 <member name="F:JetBrains.Interop.WinApi.MSOCRINFO.grfcadvf">
|
|
|
261 <summary>
|
|
|
262 Bit flags composed from the Msocadvf enumeration.
|
|
|
263 </summary>
|
|
|
264 </member>
|
|
|
265 <member name="T:JetBrains.Interop.WinApi.ConnectDll">
|
|
|
266 <summary>
|
|
|
267 Connect.dll functions.
|
|
|
268 Must be 64bit-safe.
|
|
|
269 </summary>
|
|
|
270 <remarks>
|
|
|
271 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
272 (1) All the function declarations MUST be 64-bit aware.
|
|
|
273 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
274 and you MUST ensure that each parameter has a proper size.
|
|
|
275 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
276 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
277 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
278 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
279 but slows down the execution of critical members.
|
|
|
280 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
281 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
282 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
283 This greately improves the understanding of the parameter sizes.
|
|
|
284 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
285 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
286 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
287 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
288 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
289 (A) Same rules must apply to members of the structures.
|
|
|
290 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
291 </remarks>
|
|
|
292 </member>
|
|
|
293 <member name="M:JetBrains.Interop.WinApi.ConnectDll.Helpers.IsInternetConnected">
|
|
|
294 <summary>
|
|
|
295 The IsInternetConnected function determines whether the current user is connected to the Internet.
|
|
|
296 </summary>
|
|
|
297 <remarks>Cannot call the API <c>IsInternetConnected</c> function directly because it's only available starting with NT6.</remarks>
|
|
|
298 </member>
|
|
|
299 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.STGM">
|
|
|
300 <summary>
|
|
|
301 Storage instantiation modes
|
|
|
302 </summary>
|
|
|
303 </member>
|
|
|
304 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.STGFMT.STGFMT_DOCUMENT">
|
|
|
305 <summary>
|
|
|
306 This is a legacy define to allow old component to builds
|
|
|
307 </summary>
|
|
|
308 </member>
|
|
|
309 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.FileMapAccess">
|
|
|
310 <summary>
|
|
|
311 Access flags, e.g. for <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.MapViewOfFile(System.Void*,System.UInt32,System.UInt32,System.UInt32,System.UIntPtr)"/>.
|
|
|
312 </summary>
|
|
|
313 </member>
|
|
|
314 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.KEYEVENTF">
|
|
|
315 <summary>
|
|
|
316 For <see cref="M:JetBrains.Interop.WinApi.User32Dll.keybd_event(System.Byte,System.Byte,System.UInt32,System.UIntPtr)"/>.
|
|
|
317 </summary>
|
|
|
318 </member>
|
|
|
319 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.KEYEVENTF.KEYEVENTF_EXTENDEDKEY">
|
|
|
320 <summary>
|
|
|
321 If specified, the scan code was preceded by a prefix byte having the value 0xE0 (224).
|
|
|
322 </summary>
|
|
|
323 </member>
|
|
|
324 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.KEYEVENTF.KEYEVENTF_KEYUP">
|
|
|
325 <summary>
|
|
|
326 If specified, the key is being released. If not specified, the key is being depressed.
|
|
|
327 </summary>
|
|
|
328 </member>
|
|
|
329 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.SectionFlags">
|
|
|
330 <summary>
|
|
|
331 From <c>Winnt.h</c>.
|
|
|
332 </summary>
|
|
|
333 </member>
|
|
|
334 <member name="M:JetBrains.Interop.WinApi.MsiDll.MsiCloseHandle(System.Void*)">
|
|
|
335 <summary>
|
|
|
336 The MsiCloseHandle function closes an open installation handle.
|
|
|
337 </summary>
|
|
|
338 <param name="hAny"></param>
|
|
|
339 <returns></returns>
|
|
|
340 </member>
|
|
|
341 <member name="M:JetBrains.Interop.WinApi.MsiDll.MsiGetProductPropertyW(System.Void*,System.String,System.Char*,System.UInt32*)">
|
|
|
342 <summary>
|
|
|
343 The MsiGetProductProperty function retrieves product properties. These properties are in the product database.
|
|
|
344 </summary>
|
|
|
345 </member>
|
|
|
346 <member name="M:JetBrains.Interop.WinApi.MsiDll.MsiOpenPackageExW(System.String,System.UInt32,System.Void**)">
|
|
|
347 <summary>
|
|
|
348 The MsiOpenPackageEx function opens a package to use with functions that access the product database. The MsiCloseHandle function must be called with the handle when the handle is no longer needed.
|
|
|
349 </summary>
|
|
|
350 <param name="szPackagePath"> </param>
|
|
|
351 <param name="dwOptions">MSIOPENPACKAGEFLAGS_IGNOREMACHINESTATE = 1</param>
|
|
|
352 <param name="hProduct"> </param>
|
|
|
353 </member>
|
|
|
354 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MOUSEEVENTF">
|
|
|
355 <summary>
|
|
|
356 For <see cref="M:JetBrains.Interop.WinApi.User32Dll.mouse_event(System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UIntPtr)"/>.
|
|
|
357 </summary>
|
|
|
358 </member>
|
|
|
359 <member name="T:JetBrains.Annotations.CanBeNullAttribute">
|
|
|
360 <summary>
|
|
|
361 Indicates that the value of marked element could be <c>null</c> sometimes, so the check for <c>null</c> is necessary before its usage
|
|
|
362 </summary>
|
|
|
363 </member>
|
|
|
364 <member name="T:JetBrains.Annotations.NotNullAttribute">
|
|
|
365 <summary>
|
|
|
366 Indicates that the value of marked element could never be <c>null</c>
|
|
|
367 </summary>
|
|
|
368 </member>
|
|
|
369 <member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
|
|
|
370 <summary>
|
|
|
371 Indicates that the value of marked type (or its derivatives) cannot be compared using '==' or '!=' operators.
|
|
|
372 There is only exception to compare with <c>null</c>, it is permitted
|
|
|
373 </summary>
|
|
|
374 </member>
|
|
|
375 <member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
|
|
|
376 <summary>
|
|
|
377 Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
|
|
|
378 so this symbol will not be marked as unused (as well as by other usage inspections)
|
|
|
379 </summary>
|
|
|
380 </member>
|
|
|
381 <member name="P:JetBrains.Annotations.UsedImplicitlyAttribute.TargetFlags">
|
|
|
382 <summary>
|
|
|
383 Gets value indicating what is meant to be used
|
|
|
384 </summary>
|
|
|
385 </member>
|
|
|
386 <member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
|
|
|
387 <summary>
|
|
|
388 Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes as unused (as well as by other usage inspections)
|
|
|
389 </summary>
|
|
|
390 </member>
|
|
|
391 <member name="P:JetBrains.Annotations.MeansImplicitUseAttribute.TargetFlags">
|
|
|
392 <summary>
|
|
|
393 Gets value indicating what is meant to be used
|
|
|
394 </summary>
|
|
|
395 </member>
|
|
|
396 <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
|
|
|
397 <summary>
|
|
|
398 Only entity marked with attribute considered used
|
|
|
399 </summary>
|
|
|
400 </member>
|
|
|
401 <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
|
|
|
402 <summary>
|
|
|
403 Indicates implicit assignment to a member
|
|
|
404 </summary>
|
|
|
405 </member>
|
|
|
406 <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
|
|
|
407 <summary>
|
|
|
408 Indicates implicit instantiation of a type with fixed constructor signature.
|
|
|
409 That means any unused constructor parameters won't be reported as such.
|
|
|
410 </summary>
|
|
|
411 </member>
|
|
|
412 <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
|
|
|
413 <summary>
|
|
|
414 Indicates implicit instantiation of a type
|
|
|
415 </summary>
|
|
|
416 </member>
|
|
|
417 <member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
|
|
|
418 <summary>
|
|
|
419 Specify what is considered used implicitly when marked with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>
|
|
|
420 </summary>
|
|
|
421 </member>
|
|
|
422 <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
|
|
|
423 <summary>
|
|
|
424 Members of entity marked with attribute are considered used
|
|
|
425 </summary>
|
|
|
426 </member>
|
|
|
427 <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
|
|
|
428 <summary>
|
|
|
429 Entity marked with attribute and all its members considered used
|
|
|
430 </summary>
|
|
|
431 </member>
|
|
|
432 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression">
|
|
|
433 <summary>
|
|
|
434 <see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER"/> compression values.
|
|
|
435 </summary>
|
|
|
436 </member>
|
|
|
437 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_RGB">
|
|
|
438 <summary>
|
|
|
439 An uncompressed format. (<see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER"/> version 5)
|
|
|
440 </summary>
|
|
|
441 </member>
|
|
|
442 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_RLE8">
|
|
|
443 <summary>
|
|
|
444 A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression.
|
|
|
445 </summary>
|
|
|
446 </member>
|
|
|
447 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_RLE4">
|
|
|
448 <summary>
|
|
|
449 An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression.
|
|
|
450 </summary>
|
|
|
451 </member>
|
|
|
452 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_BITFIELDS">
|
|
|
453 <summary>
|
|
|
454 Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps.
|
|
|
455 </summary>
|
|
|
456 </member>
|
|
|
457 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_JPEG">
|
|
|
458 <summary>
|
|
|
459 Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image.
|
|
|
460 </summary>
|
|
|
461 </member>
|
|
|
462 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression.BI_PNG">
|
|
|
463 <summary>
|
|
|
464 Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image.
|
|
|
465 </summary>
|
|
|
466 </member>
|
|
|
467 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition.New">
|
|
|
468 <summary>
|
|
|
469 Creates a new file. The function fails if a specified file exists.
|
|
|
470 </summary>
|
|
|
471 </member>
|
|
|
472 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition.CreateAlways">
|
|
|
473 <summary>
|
|
|
474 Creates a new file, always.
|
|
|
475 If a file exists, the function overwrites the file, clears the existing attributes, combines the specified file attributes,
|
|
|
476 and flags with FILE_ATTRIBUTE_ARCHIVE, but does not set the security descriptor that the SECURITY_ATTRIBUTES structure specifies.
|
|
|
477 </summary>
|
|
|
478 </member>
|
|
|
479 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition.OpenExisting">
|
|
|
480 <summary>
|
|
|
481 Opens a file. The function fails if the file does not exist.
|
|
|
482 </summary>
|
|
|
483 </member>
|
|
|
484 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition.OpenAlways">
|
|
|
485 <summary>
|
|
|
486 Opens a file, always.
|
|
|
487 If a file does not exist, the function creates a file as if dwCreationDisposition is CREATE_NEW.
|
|
|
488 </summary>
|
|
|
489 </member>
|
|
|
490 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition.TruncateExisting">
|
|
|
491 <summary>
|
|
|
492 Opens a file and truncates it so that its size is 0 (zero) bytes. The function fails if the file does not exist.
|
|
|
493 The calling process must open the file with the GENERIC_WRITE access right.
|
|
|
494 </summary>
|
|
|
495 </member>
|
|
|
496 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.FileShareFlags.Read">
|
|
|
497 <summary>
|
|
|
498 Enables subsequent open operations on an object to request read access.
|
|
|
499 Otherwise, other processes cannot open the object if they request read access.
|
|
|
500 If this flag is not specified, but the object has been opened for read access, the function fails.
|
|
|
501 </summary>
|
|
|
502 </member>
|
|
|
503 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.FileShareFlags.Write">
|
|
|
504 <summary>
|
|
|
505 Enables subsequent open operations on an object to request write access.
|
|
|
506 Otherwise, other processes cannot open the object if they request write access.
|
|
|
507 If this flag is not specified, but the object has been opened for write access, the function fails.
|
|
|
508 </summary>
|
|
|
509 </member>
|
|
|
510 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.FileShareFlags.Delete">
|
|
|
511 <summary>
|
|
|
512 Enables subsequent open operations on an object to request delete access.
|
|
|
513 Otherwise, other processes cannot open the object if they request delete access.
|
|
|
514 If this flag is not specified, but the object has been opened for delete access, the function fails.
|
|
|
515 </summary>
|
|
|
516 </member>
|
|
|
517 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.HookCode">
|
|
|
518 <summary>
|
|
|
519 Hook codes for callback functions of <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowsHookEx(JetBrains.Interop.WinApi.HookType,JetBrains.Interop.WinApi.Win32Declarations.HookProc,System.IntPtr,System.Int32)"/>.
|
|
|
520 </summary>
|
|
|
521 </member>
|
|
|
522 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.HookCode.HC_ACTION">
|
|
|
523 <summary>
|
|
|
524 Mouse hook: The wParam and lParam parameters contain information about a mouse message.
|
|
|
525 </summary>
|
|
|
526 </member>
|
|
|
527 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.HookCode.HC_NOREMOVE">
|
|
|
528 <summary>
|
|
|
529 Mouse hook: The wParam and lParam parameters contain information about a mouse message, and the mouse message has not been removed from the message queue. (An application called the PeekMessage function, specifying the PM_NOREMOVE flag.)
|
|
|
530 </summary>
|
|
|
531 </member>
|
|
|
532 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes">
|
|
|
533 <summary>
|
|
|
534 The type of memory allocation. This parameter must contain one of the following values.
|
|
|
535 </summary>
|
|
|
536 </member>
|
|
|
537 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_COMMIT">
|
|
|
538 <summary>
|
|
|
539 Allocates physical storage in memory or in the paging file on disk for the specified reserved memory pages. The function initializes the memory to zero.
|
|
|
540 To reserve and commit pages in one step, call VirtualAlloc with MEM_COMMIT | MEM_RESERVE.
|
|
|
541 The function fails if you attempt to commit a page that has not been reserved. The resulting error code is ERROR_INVALID_ADDRESS.
|
|
|
542 An attempt to commit a page that is already committed does not cause the function to fail. This means that you can commit pages without first determining the current commitment state of each page.
|
|
|
543 </summary>
|
|
|
544 </member>
|
|
|
545 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_RESERVE">
|
|
|
546 <summary>
|
|
|
547 Reserves a range of the process's virtual address space without allocating any actual physical storage in memory or in the paging file on disk.
|
|
|
548 You can commit reserved pages in subsequent calls to the VirtualAlloc function. To reserve and commit pages in one step, call VirtualAlloc with MEM_COMMIT | MEM_RESERVE.
|
|
|
549 Other memory allocation functions, such as malloc and LocalAlloc, cannot use a reserved range of memory until it is released.
|
|
|
550 </summary>
|
|
|
551 </member>
|
|
|
552 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_RESET">
|
|
|
553 <summary>
|
|
|
554 Indicates that data in the memory range specified by lpAddress and dwSize is no longer of interest. The pages should not be read from or written to the paging file. However, the memory block will be used again later, so it should not be decommitted. This value cannot be used with any other value.
|
|
|
555 Using this value does not guarantee that the range operated on with MEM_RESET will contain zeroes. If you want the range to contain zeroes, decommit the memory and then recommit it.
|
|
|
556 When you specify MEM_RESET, the VirtualAlloc function ignores the value of flProtect. However, you must still set flProtect to a valid protection value, such as PAGE_NOACCESS.
|
|
|
557 VirtualAlloc returns an error if you use MEM_RESET and the range of memory is mapped to a file. A shared view is only acceptable if it is mapped to a paging file.
|
|
|
558 </summary>
|
|
|
559 </member>
|
|
|
560 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_FREE">
|
|
|
561 <summary>
|
|
|
562 Indicates free pages not accessible to the calling process and available to be allocated. For free pages, the information in the AllocationBase, AllocationProtect, Protect, and Type members is undefined.
|
|
|
563 </summary>
|
|
|
564 </member>
|
|
|
565 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_LARGE_PAGES">
|
|
|
566 <summary>
|
|
|
567 Allocates memory using large page support.
|
|
|
568 The size and alignment must be a multiple of the large-page minimum. To obtain this value, use the GetLargePageMinimum function.
|
|
|
569 Windows XP/2000: This flag is not supported.
|
|
|
570 </summary>
|
|
|
571 </member>
|
|
|
572 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_PHYSICAL">
|
|
|
573 <summary>
|
|
|
574 Reserves an address range that can be used to map Address Windowing Extensions (AWE) pages.
|
|
|
575 This value must be used with MEM_RESERVE and no other values.
|
|
|
576 </summary>
|
|
|
577 </member>
|
|
|
578 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_TOP_DOWN">
|
|
|
579 <summary>
|
|
|
580 Allocates memory at the highest possible address.
|
|
|
581 </summary>
|
|
|
582 </member>
|
|
|
583 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_WRITE_WATCH">
|
|
|
584 <summary>
|
|
|
585 Causes the system to track pages that are written to in the allocated region. If you specify this value, you must also specify MEM_RESERVE.
|
|
|
586 To retrieve the addresses of the pages that have been written to since the region was allocated or the write-tracking state was reset, call the GetWriteWatch function. To reset the write-tracking state, call GetWriteWatch or ResetWriteWatch. The write-tracking feature remains enabled for the memory region until the region is freed.
|
|
|
587 Windows 2000: This flag is not supported.
|
|
|
588 </summary>
|
|
|
589 </member>
|
|
|
590 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryPageTypes">
|
|
|
591 <summary>
|
|
|
592 The type of pages in the region. The following types are defined.
|
|
|
593 </summary>
|
|
|
594 </member>
|
|
|
595 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryPageTypes.MEM_IMAGE">
|
|
|
596 <summary>
|
|
|
597 Indicates that the memory pages within the region are mapped into the view of an image section.
|
|
|
598 </summary>
|
|
|
599 </member>
|
|
|
600 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryPageTypes.MEM_MAPPED">
|
|
|
601 <summary>
|
|
|
602 Indicates that the memory pages within the region are mapped into the view of a section.
|
|
|
603 </summary>
|
|
|
604 </member>
|
|
|
605 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryPageTypes.MEM_PRIVATE">
|
|
|
606 <summary>
|
|
|
607 Indicates that the memory pages within the region are private (that is, not shared by other processes).
|
|
|
608 </summary>
|
|
|
609 </member>
|
|
|
610 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants">
|
|
|
611 <summary>
|
|
|
612 The following are the memory-protection options; you must specify one of the following values when allocating or protecting a page in memory. Protection attributes cannot be assigned to a portion of a page; they can only be assigned to a whole page.
|
|
|
613 </summary>
|
|
|
614 </member>
|
|
|
615 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_EXECUTE">
|
|
|
616 <summary>
|
|
|
617 Enables execute access to the committed region of pages. An attempt to read from or write to the committed region results in an access violation.
|
|
|
618 This flag is not supported by the CreateFileMapping function.
|
|
|
619 </summary>
|
|
|
620 </member>
|
|
|
621 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_EXECUTE_READ">
|
|
|
622 <summary>
|
|
|
623 Enables execute or read-only access to the committed region of pages. An attempt to write to the committed region results in an access violation.
|
|
|
624 Windows Server 2003 and Windows XP/2000: This attribute is not supported by the CreateFileMapping function until Windows XP with SP2 and Windows Server 2003 with SP1.
|
|
|
625 </summary>
|
|
|
626 </member>
|
|
|
627 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_EXECUTE_READWRITE">
|
|
|
628 <summary>
|
|
|
629 Enables execute, read-only, or read/write access to the committed region of pages.
|
|
|
630 Windows Server 2003 and Windows XP/2000: This attribute is not supported by the CreateFileMapping function until Windows XP with SP2 and Windows Server 2003 with SP1.
|
|
|
631 </summary>
|
|
|
632 </member>
|
|
|
633 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_EXECUTE_WRITECOPY">
|
|
|
634 <summary>
|
|
|
635 Enables execute, read-only, or copy-on-write access to a mapped view of a file mapping object. An attempt to write to a committed copy-on-write page results in a private copy of the page being made for the process. The private page is marked as PAGE_EXECUTE_READWRITE, and the change is written to the new page.
|
|
|
636 This flag is not supported by the VirtualAlloc or VirtualAllocEx functions.
|
|
|
637 Windows Vista, Windows Server 2003, and Windows XP/2000: This attribute is not supported by the CreateFileMapping function until Windows Vista with SP1 and Windows Server 2008.
|
|
|
638 </summary>
|
|
|
639 </member>
|
|
|
640 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_NOACCESS">
|
|
|
641 <summary>
|
|
|
642 Disables all access to the committed region of pages. An attempt to read from, write to, or execute the committed region results in an access violation.
|
|
|
643 This flag is not supported by the CreateFileMapping function.
|
|
|
644 </summary>
|
|
|
645 </member>
|
|
|
646 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_READONLY">
|
|
|
647 <summary>
|
|
|
648 Enables read-only access to the committed region of pages. An attempt to write to the committed region results in an access violation. If Data Execution Prevention is enabled, an attempt to execute code in the committed region results in an access violation.
|
|
|
649 </summary>
|
|
|
650 </member>
|
|
|
651 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_READWRITE">
|
|
|
652 <summary>
|
|
|
653 Enables read-only or read/write access to the committed region of pages. If Data Execution Prevention is enabled, attempting to execute code in the committed region results in an access violation.
|
|
|
654 </summary>
|
|
|
655 </member>
|
|
|
656 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_WRITECOPY">
|
|
|
657 <summary>
|
|
|
658 Enables read-only or copy-on-write access to a mapped view of a file mapping object. An attempt to write to a committed copy-on-write page results in a private copy of the page being made for the process. The private page is marked as PAGE_READWRITE, and the change is written to the new page. If Data Execution Prevention is enabled, attempting to execute code in the committed region results in an access violation.
|
|
|
659 This flag is not supported by the VirtualAlloc or VirtualAllocEx functions.
|
|
|
660 </summary>
|
|
|
661 </member>
|
|
|
662 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_GUARD">
|
|
|
663 <summary>
|
|
|
664 Pages in the region become guard pages. Any attempt to access a guard page causes the system to raise a STATUS_GUARD_PAGE_VIOLATION exception and turn off the guard page status. Guard pages thus act as a one-time access alarm. For more information, see Creating Guard Pages.
|
|
|
665 When an access attempt leads the system to turn off guard page status, the underlying page protection takes over.
|
|
|
666 If a guard page exception occurs during a system service, the service typically returns a failure status indicator.
|
|
|
667 This value cannot be used with PAGE_NOACCESS.
|
|
|
668 This flag is not supported by the CreateFileMapping function.
|
|
|
669 </summary>
|
|
|
670 </member>
|
|
|
671 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_NOCACHE">
|
|
|
672 <summary>
|
|
|
673 Sets all pages to be non-cachable. Applications should not use this attribute except when explicitly required for a device. Using the interlocked functions with memory that is mapped with SEC_NOCACHE can result in an EXCEPTION_ILLEGAL_INSTRUCTION exception.
|
|
|
674 The PAGE_NOCACHE flag cannot be used with the PAGE_GUARD, PAGE_NOACCESS, or PAGE_WRITECOMBINE flags.
|
|
|
675 The PAGE_NOCACHE flag can be used only when allocating private memory with the VirtualAlloc, VirtualAllocEx, or VirtualAllocExNuma functions. To enable non-cached memory access for shared memory, specify the SEC_NOCACHE flag when calling the CreateFileMapping function.
|
|
|
676 </summary>
|
|
|
677 </member>
|
|
|
678 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants.PAGE_WRITECOMBINE">
|
|
|
679 <summary>
|
|
|
680 Sets all pages to be write-combined.
|
|
|
681 Applications should not use this attribute except when explicitly required for a device. Using the interlocked functions with memory that is mapped as write-combined can result in an EXCEPTION_ILLEGAL_INSTRUCTION exception.
|
|
|
682 The PAGE_WRITECOMBINE flag cannot be specified with the PAGE_NOACCESS, PAGE_GUARD, and PAGE_NOCACHE flags.
|
|
|
683 The PAGE_WRITECOMBINE flag can be used only when allocating private memory with the VirtualAlloc, VirtualAllocEx, or VirtualAllocExNuma functions. To enable write-combined memory access for shared memory, specify the SEC_WRITECOMBINE flag when calling the CreateFileMapping function.
|
|
|
684 Windows Server 2003 and Windows XP/2000: This flag is not supported until Windows Server 2003 with SP1.
|
|
|
685 </summary>
|
|
|
686 </member>
|
|
|
687 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.PropSheetPageProcMsg">
|
|
|
688 <summary>
|
|
|
689 <see cref="T:JetBrains.Interop.WinApi.Declarations.Functions.LPFNPSPCALLBACK"/> <c>msg</c> parameter.
|
|
|
690 Action flag. This parameter can be one of the following values.
|
|
|
691 </summary>
|
|
|
692 </member>
|
|
|
693 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.PropSheetPageProcMsg.PSPCB_ADDREF">
|
|
|
694 <summary>
|
|
|
695 Version 5.80 or later. A page is being created. The return value is not used.
|
|
|
696 </summary>
|
|
|
697 </member>
|
|
|
698 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.PropSheetPageProcMsg.PSPCB_CREATE">
|
|
|
699 <summary>
|
|
|
700 A dialog box for a page is being created. Return nonzero to allow it to be created, or zero to prevent it.
|
|
|
701 </summary>
|
|
|
702 </member>
|
|
|
703 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.PropSheetPageProcMsg.PSPCB_RELEASE">
|
|
|
704 <summary>
|
|
|
705 A page is being destroyed. The return value is ignored.
|
|
|
706 </summary>
|
|
|
707 </member>
|
|
|
708 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags">
|
|
|
709 <summary>
|
|
|
710 Flags for the <see cref="M:JetBrains.Interop.WinApi.Shell32Dll.SHGetFileInfoW(System.String,System.UInt32,JetBrains.Interop.WinApi.SHFILEINFO*,System.UInt32,System.UInt32)"/> function.
|
|
|
711 </summary>
|
|
|
712 </member>
|
|
|
713 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_ADDOVERLAYS">
|
|
|
714 <summary>Version 5.0. Apply the appropriate overlays to the file's icon. The SHGFI_ICON flag must also be set.</summary>
|
|
|
715 </member>
|
|
|
716 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_ATTR_SPECIFIED">
|
|
|
717 <summary>Modify SHGFI_ATTRIBUTES to indicate that the dwAttributes member of the SHFILEINFO structure at psfi contains the specific attributes that are desired. These attributes are passed to IShellFolder::GetAttributesOf. If this flag is not specified, 0xFFFFFFFF is passed to IShellFolder::GetAttributesOf, requesting all attributes. This flag cannot be specified with the SHGFI_ICON flag.</summary>
|
|
|
718 </member>
|
|
|
719 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_ATTRIBUTES">
|
|
|
720 <summary>Retrieve the item attributes. The attributes are copied to the dwAttributes member of the structure specified in the psfi parameter. These are the same attributes that are obtained from IShellFolder::GetAttributesOf.</summary>
|
|
|
721 </member>
|
|
|
722 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_DISPLAYNAME">
|
|
|
723 <summary>Retrieve the display name for the file. The name is copied to the szDisplayName member of the structure specified in psfi. The returned display name uses the long file name, if there is one, rather than the 8.3 form of the file name.</summary>
|
|
|
724 </member>
|
|
|
725 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_EXETYPE">
|
|
|
726 <summary>Retrieve the type of the executable file if pszPath identifies an executable file. The information is packed into the return value. This flag cannot be specified with any other flags.</summary>
|
|
|
727 </member>
|
|
|
728 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_ICON">
|
|
|
729 <summary>Retrieve the handle to the icon that represents the file and the index of the icon within the system image list. The handle is copied to the hIcon member of the structure specified by psfi, and the index is copied to the iIcon member.</summary>
|
|
|
730 </member>
|
|
|
731 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_ICONLOCATION">
|
|
|
732 <summary>Retrieve the name of the file that contains the icon representing the file specified by pszPath, as returned by the IExtractIcon::GetIconLocation method of the file's icon handler. Also retrieve the icon index within that file. The name of the file containing the icon is copied to the szDisplayName member of the structure specified by psfi. The icon's index is copied to that structure's iIcon member.</summary>
|
|
|
733 </member>
|
|
|
734 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_LARGEICON">
|
|
|
735 <summary>Modify SHGFI_ICON, causing the function to retrieve the file's large icon. The SHGFI_ICON flag must also be set.</summary>
|
|
|
736 </member>
|
|
|
737 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_LINKOVERLAY">
|
|
|
738 <summary>Modify SHGFI_ICON, causing the function to add the link overlay to the file's icon. The SHGFI_ICON flag must also be set.</summary>
|
|
|
739 </member>
|
|
|
740 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_OPENICON">
|
|
|
741 <summary>Modify SHGFI_ICON, causing the function to retrieve the file's open icon. Also used to modify SHGFI_SYSICONINDEX, causing the function to return the handle to the system image list that contains the file's small open icon. A container object displays an open icon to indicate that the container is open. The SHGFI_ICON and/or SHGFI_SYSICONINDEX flag must also be set.</summary>
|
|
|
742 </member>
|
|
|
743 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_OVERLAYINDEX">
|
|
|
744 <summary>Version 5.0. Return the index of the overlay icon. The value of the overlay index is returned in the upper eight bits of the iIcon member of the structure specified by psfi. This flag requires that the SHGFI_ICON be set as well.</summary>
|
|
|
745 </member>
|
|
|
746 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_PIDL">
|
|
|
747 <summary>Indicate that pszPath is the address of an ITEMIDLIST structure rather than a path name.</summary>
|
|
|
748 </member>
|
|
|
749 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_SELECTED">
|
|
|
750 <summary>Modify SHGFI_ICON, causing the function to blend the file's icon with the system highlight color. The SHGFI_ICON flag must also be set.</summary>
|
|
|
751 </member>
|
|
|
752 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_SHELLICONSIZE">
|
|
|
753 <summary>Modify SHGFI_ICON, causing the function to retrieve a Shell-sized icon. If this flag is not specified the function sizes the icon according to the system metric values. The SHGFI_ICON flag must also be set.</summary>
|
|
|
754 </member>
|
|
|
755 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_SMALLICON">
|
|
|
756 <summary>Modify SHGFI_ICON, causing the function to retrieve the file's small icon. Also used to modify SHGFI_SYSICONINDEX, causing the function to return the handle to the system image list that contains small icon images. The SHGFI_ICON and/or SHGFI_SYSICONINDEX flag must also be set.</summary>
|
|
|
757 </member>
|
|
|
758 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_SYSICONINDEX">
|
|
|
759 <summary>Retrieve the index of a system image list icon. If successful, the index is copied to the iIcon member of psfi. The return value is a handle to the system image list. Only those images whose indices are successfully copied to iIcon are valid. Attempting to access other images in the system image list will result in undefined behavior.</summary>
|
|
|
760 </member>
|
|
|
761 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_TYPENAME">
|
|
|
762 <summary>Retrieve the string that describes the file's type. The string is copied to the szTypeName member of the structure specified in psfi.</summary>
|
|
|
763 </member>
|
|
|
764 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags.SHGFI_USEFILEATTRIBUTES">
|
|
|
765 <summary>Indicates that the function should not attempt to access the file specified by pszPath. Rather, it should act as if the file specified by pszPath exists with the file attributes passed in dwFileAttributes. This flag cannot be combined with the SHGFI_ATTRIBUTES, SHGFI_EXETYPE, or SHGFI_PIDL flags.</summary>
|
|
|
766 </member>
|
|
|
767 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.UxThemeClasses">
|
|
|
768 <summary>
|
|
|
769 Classes for <see cref="T:JetBrains.Interop.WinApi.UxThemeDll"/> functions like <see cref="M:JetBrains.Interop.WinApi.UxThemeDll.OpenThemeData(System.Void*,System.String)"/>.
|
|
|
770 </summary>
|
|
|
771 </member>
|
|
|
772 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.UxThemeParts">
|
|
|
773 <summary>
|
|
|
774 Parts for <see cref="T:JetBrains.Interop.WinApi.UxThemeDll"/> functions like <see cref="M:JetBrains.Interop.WinApi.UxThemeDll.DrawThemeBackground(System.Void*,System.Void*,System.Int32,System.Int32,JetBrains.Interop.WinApi.RECT*,JetBrains.Interop.WinApi.RECT*)"/>.
|
|
|
775 </summary>
|
|
|
776 </member>
|
|
|
777 <member name="T:JetBrains.Interop.WinApi.Declarations.Functions.LPFNPSPCALLBACK">
|
|
|
778 <summary>
|
|
|
779 Function type for the <see cref="F:JetBrains.Interop.WinApi.Declarations.Structures.PROPSHEETPAGE.pfnCallback"/> field.
|
|
|
780 </summary>
|
|
|
781 <param name="hwnd"></param>
|
|
|
782 <param name="nMsg">See <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.PropSheetPageProcMsg"/> members for values.</param>
|
|
|
783 <param name="ppsp"></param>
|
|
|
784 <returns></returns>
|
|
|
785 </member>
|
|
|
786 <member name="T:JetBrains.Interop.WinApi.IpHlpApiDll">
|
|
|
787 <summary>
|
|
|
788 User32.dll functions.
|
|
|
789 Must be 64bit-safe.
|
|
|
790 </summary>
|
|
|
791 <remarks>
|
|
|
792 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
793 (1) All the function declarations MUST be 64-bit aware.
|
|
|
794 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
795 and you MUST ensure that each parameter has a proper size.
|
|
|
796 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
797 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
798 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
799 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
800 but slows down the execution of critical members.
|
|
|
801 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
802 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
803 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
804 This greately improves the understanding of the parameter sizes.
|
|
|
805 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
806 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
807 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
808 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
809 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
810 (A) Same rules must apply to members of the structures.
|
|
|
811 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
812 </remarks>
|
|
|
813 </member>
|
|
|
814 <member name="T:JetBrains.Interop.WinApi.ShlwapiDll">
|
|
|
815 <summary>
|
|
|
816 Shlwapi.dll functions.
|
|
|
817 Must be 64bit-safe.
|
|
|
818 </summary>
|
|
|
819 <remarks>
|
|
|
820 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
821 (1) All the function declarations MUST be 64-bit aware.
|
|
|
822 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
823 and you MUST ensure that each parameter has a proper size.
|
|
|
824 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
825 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
826 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
827 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
828 but slows down the execution of critical members.
|
|
|
829 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
830 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
831 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
832 This greately improves the understanding of the parameter sizes.
|
|
|
833 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
834 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
835 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
836 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
837 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
838 (A) Same rules must apply to members of the structures.
|
|
|
839 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
840 </remarks>
|
|
|
841 </member>
|
|
|
842 <member name="T:JetBrains.Interop.WinApi.NtDllDll">
|
|
|
843 <summary>
|
|
|
844 NtDll.dll functions.
|
|
|
845 Must be 64bit-safe.
|
|
|
846 </summary>
|
|
|
847 <remarks>
|
|
|
848 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
849 (1) All the function declarations MUST be 64-bit aware.
|
|
|
850 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
851 and you MUST ensure that each parameter has a proper size.
|
|
|
852 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
853 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
854 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
855 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
856 but slows down the execution of critical members.
|
|
|
857 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
858 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
859 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
860 This greately improves the understanding of the parameter sizes.
|
|
|
861 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
862 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
863 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
864 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
865 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
866 (A) Same rules must apply to members of the structures.
|
|
|
867 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
868 </remarks>
|
|
|
869 </member>
|
|
|
870 <member name="T:JetBrains.Interop.WinApi.SHFILEINFO">
|
|
|
871 <summary>
|
|
|
872 Contains information about a file object.
|
|
|
873 </summary>
|
|
|
874 </member>
|
|
|
875 <member name="F:JetBrains.Interop.WinApi.SHFILEINFO.hIcon">
|
|
|
876 <summary>
|
|
|
877 A handle to the icon that represents the file. You are responsible for destroying this handle with DestroyIcon when you no longer need it.
|
|
|
878 </summary>
|
|
|
879 </member>
|
|
|
880 <member name="F:JetBrains.Interop.WinApi.SHFILEINFO.iIcon">
|
|
|
881 <summary>
|
|
|
882 The index of the icon image within the system image list.
|
|
|
883 </summary>
|
|
|
884 </member>
|
|
|
885 <member name="F:JetBrains.Interop.WinApi.SHFILEINFO.dwAttributes">
|
|
|
886 <summary>
|
|
|
887 An array of values that indicates the attributes of the file object. For information about these values, see the IShellFolder::GetAttributesOf method.
|
|
|
888 </summary>
|
|
|
889 </member>
|
|
|
890 <member name="F:JetBrains.Interop.WinApi.SHFILEINFO.szDisplayName">
|
|
|
891 <summary>
|
|
|
892 A string that contains the name of the file as it appears in the Windows Shell, or the path and file name of the file that contains the icon representing the file.
|
|
|
893 </summary>
|
|
|
894 </member>
|
|
|
895 <member name="F:JetBrains.Interop.WinApi.SHFILEINFO.szTypeName">
|
|
|
896 <summary>
|
|
|
897 A string that describes the type of file.
|
|
|
898 </summary>
|
|
|
899 </member>
|
|
|
900 <member name="T:JetBrains.Interop.WinApi.PsApiDll">
|
|
|
901 <summary>
|
|
|
902 Kernel32.dll functions.
|
|
|
903 Must be 64bit-safe.
|
|
|
904 </summary>
|
|
|
905 <remarks>
|
|
|
906 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
907 (1) All the function declarations MUST be 64-bit aware.
|
|
|
908 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
909 and you MUST ensure that each parameter has a proper size.
|
|
|
910 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
911 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
912 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
913 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
914 but slows down the execution of critical members.
|
|
|
915 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
916 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
917 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
918 This greately improves the understanding of the parameter sizes.
|
|
|
919 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
920 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
921 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
922 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
923 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
924 (A) Same rules must apply to members of the structures.
|
|
|
925 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
926 </remarks>
|
|
|
927 </member>
|
|
|
928 <member name="M:JetBrains.Interop.WinApi.PsApiDll.EnumProcessModules(System.Void*,System.Void**,System.UInt32,System.UInt32*)">
|
|
|
929 <summary>
|
|
|
930 Retrieves a handle for each module in the specified process.
|
|
|
931 To control whether a 64-bit application enumerates 32-bit modules, 64-bit modules, or both types of modules, use the EnumProcessModulesEx function.
|
|
|
932 </summary>
|
|
|
933 <param name="hProcess">A handle to the process.</param>
|
|
|
934 <param name="lphModule">An array that receives the list of module handles.</param>
|
|
|
935 <param name="cb">The size of the lphModule array, in bytes.</param>
|
|
|
936 <param name="lpcbNeeded">The number of bytes required to store all module handles in the lphModule array.</param>
|
|
|
937 <returns>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.</returns>
|
|
|
938 <remarks>
|
|
|
939 […]
|
|
|
940 It is a good idea to specify a large array of HMODULE values, because it is hard to predict how many modules there will be in the process at the time you call EnumProcessModules. To determine if the lphModule array is too small to hold all module handles for the process, compare the value returned in lpcbNeeded with the value specified in cb. If lpcbNeeded is greater than cb, increase the size of the array and call EnumProcessModules again.
|
|
|
941 To determine how many modules were enumerated by the call to EnumProcessModules, divide the resulting value in the lpcbNeeded parameter by sizeof(HMODULE).
|
|
|
942 […]
|
|
|
943 </remarks>
|
|
|
944 </member>
|
|
|
945 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER">
|
|
|
946 <summary>
|
|
|
947 The BITMAPINFOHEADER structure contains information about the dimensions and color format of a DIB.
|
|
|
948 </summary>
|
|
|
949 </member>
|
|
|
950 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biSize">
|
|
|
951 <summary>
|
|
|
952 Specifies the number of bytes required by the structure.
|
|
|
953 </summary>
|
|
|
954 </member>
|
|
|
955 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biWidth">
|
|
|
956 <summary>
|
|
|
957 Specifies the width of the bitmap, in pixels.
|
|
|
958 Windows 98/Me, Windows 2000/XP: If biCompression is BI_JPEG or BI_PNG, the biWidth member specifies the width of the decompressed JPEG or PNG image file, respectively.
|
|
|
959 </summary>
|
|
|
960 </member>
|
|
|
961 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biHeight">
|
|
|
962 <summary>
|
|
|
963 Specifies the height of the bitmap, in pixels. If biHeight is positive, the bitmap is a bottom-up DIB and its origin is the lower-left corner. If biHeight is negative, the bitmap is a top-down DIB and its origin is the upper-left corner.
|
|
|
964 If biHeight is negative, indicating a top-down DIB, biCompression must be either BI_RGB or BI_BITFIELDS. Top-down DIBs cannot be compressed.
|
|
|
965 Windows 98/Me, Windows 2000/XP: If biCompression is BI_JPEG or BI_PNG, the biHeight member specifies the height of the decompressed JPEG or PNG image file, respectively.
|
|
|
966 </summary>
|
|
|
967 </member>
|
|
|
968 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biPlanes">
|
|
|
969 <summary>
|
|
|
970 Specifies the number of planes for the target device. This value must be set to 1.
|
|
|
971 </summary>
|
|
|
972 </member>
|
|
|
973 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biBitCount">
|
|
|
974 <summary>
|
|
|
975 Specifies the number of bits-per-pixel. The biBitCount member of the BITMAPINFOHEADER structure determines the number of bits that define each pixel and the maximum number of colors in the bitmap. This member must be one of the following values.
|
|
|
976 Value Meaning
|
|
|
977 0 Windows 98/Me, Windows 2000/XP: The number of bits-per-pixel is specified or is implied by the JPEG or PNG format.
|
|
|
978 1 The bitmap is monochrome, and the bmiColors member of BITMAPINFO contains two entries. Each bit in the bitmap array represents a pixel. If the bit is clear, the pixel is displayed with the color of the first entry in the bmiColors table; if the bit is set, the pixel has the color of the second entry in the table.
|
|
|
979 4 The bitmap has a maximum of 16 colors, and the bmiColors member of BITMAPINFO contains up to 16 entries. Each pixel in the bitmap is represented by a 4-bit index into the color table. For example, if the first byte in the bitmap is 0x1F, the byte represents two pixels. The first pixel contains the color in the second table entry, and the second pixel contains the color in the sixteenth table entry.
|
|
|
980 8 The bitmap has a maximum of 256 colors, and the bmiColors member of BITMAPINFO contains up to 256 entries. In this case, each byte in the array represents a single pixel.
|
|
|
981 16 The bitmap has a maximum of 2^16 colors. If the biCompression member of the BITMAPINFOHEADER is BI_RGB, the bmiColors member of BITMAPINFO is NULL. Each WORD in the bitmap array represents a single pixel. The relative intensities of red, green, and blue are represented with five bits for each color component. The value for blue is in the least significant five bits, followed by five bits each for green and red. The most significant bit is not used. The bmiColors color table is used for optimizing colors used on palette-based devices, and must contain the number of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
|
|
|
982 If the biCompression member of the BITMAPINFOHEADER is BI_BITFIELDS, the bmiColors member contains three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. Each WORD in the bitmap array represents a single pixel.
|
|
|
983 Windows NT/Windows 2000/XP: When the biCompression member is BI_BITFIELDS, bits set in each DWORD mask must be contiguous and should not overlap the bits of another mask. All the bits in the pixel do not have to be used.
|
|
|
984 Windows 95/98/Me: When the biCompression member is BI_BITFIELDS, the system supports only the following 16bpp color masks: A 5-5-5 16-bit image, where the blue mask is 0x001F, the green mask is 0x03E0, and the red mask is 0x7C00; and a 5-6-5 16-bit image, where the blue mask is 0x001F, the green mask is 0x07E0, and the red mask is 0xF800.
|
|
|
985 24 The bitmap has a maximum of 2^24 colors, and the bmiColors member of BITMAPINFO is NULL. Each 3-byte triplet in the bitmap array represents the relative intensities of blue, green, and red, respectively, for a pixel. The bmiColors color table is used for optimizing colors used on palette-based devices, and must contain the number of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
|
|
|
986 32 The bitmap has a maximum of 2^32 colors. If the biCompression member of the BITMAPINFOHEADER is BI_RGB, the bmiColors member of BITMAPINFO is NULL. Each DWORD in the bitmap array represents the relative intensities of blue, green, and red, respectively, for a pixel. The high byte in each DWORD is not used. The bmiColors color table is used for optimizing colors used on palette-based devices, and must contain the number of entries specified by the biClrUsed member of the BITMAPINFOHEADER.
|
|
|
987 If the biCompression member of the BITMAPINFOHEADER is BI_BITFIELDS, the bmiColors member contains three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. Each DWORD in the bitmap array represents a single pixel.
|
|
|
988 Windows NT/ 2000: When the biCompression member is BI_BITFIELDS, bits set in each DWORD mask must be contiguous and should not overlap the bits of another mask. All the bits in the pixel do not need to be used.
|
|
|
989 Windows 95/98/Me: When the biCompression member is BI_BITFIELDS, the system supports only the following 32-bpp color mask: The blue mask is 0x000000FF, the green mask is 0x0000FF00, and the red mask is 0x00FF0000.
|
|
|
990 </summary>
|
|
|
991 </member>
|
|
|
992 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biCompression">
|
|
|
993 <summary>
|
|
|
994 Use <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.BiCompression"/>.
|
|
|
995 Specifies the type of compression for a compressed bottom-up bitmap (top-down DIBs cannot be compressed). This member can be one of the following values.
|
|
|
996 Value Description
|
|
|
997 BI_RGB An uncompressed format.
|
|
|
998 BI_RLE8 A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression.
|
|
|
999 BI_RLE4 An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression.
|
|
|
1000 BI_BITFIELDS Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps.
|
|
|
1001 BI_JPEG Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image.
|
|
|
1002 BI_PNG Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image.
|
|
|
1003 </summary>
|
|
|
1004 </member>
|
|
|
1005 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biSizeImage">
|
|
|
1006 <summary>
|
|
|
1007 Specifies the size, in bytes, of the image. This may be set to zero for BI_RGB bitmaps.
|
|
|
1008 Windows 98/Me, Windows 2000/XP: If biCompression is BI_JPEG or BI_PNG, biSizeImage indicates the size of the JPEG or PNG image buffer, respectively.
|
|
|
1009 </summary>
|
|
|
1010 </member>
|
|
|
1011 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biXPelsPerMeter">
|
|
|
1012 <summary>
|
|
|
1013 Specifies the horizontal resolution, in pixels-per-meter, of the target device for the bitmap. An application can use this value to select a bitmap from a resource group that best matches the characteristics of the current device.
|
|
|
1014 </summary>
|
|
|
1015 </member>
|
|
|
1016 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biYPelsPerMeter">
|
|
|
1017 <summary>
|
|
|
1018 Specifies the vertical resolution, in pixels-per-meter, of the target device for the bitmap.
|
|
|
1019 </summary>
|
|
|
1020 </member>
|
|
|
1021 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biClrUsed">
|
|
|
1022 <summary>
|
|
|
1023 Specifies the number of color indexes in the color table that are actually used by the bitmap. If this value is zero, the bitmap uses the maximum number of colors corresponding to the value of the biBitCount member for the compression mode specified by biCompression.
|
|
|
1024 If biClrUsed is nonzero and the biBitCount member is less than 16, the biClrUsed member specifies the actual number of colors the graphics engine or device driver accesses. If biBitCount is 16 or greater, the biClrUsed member specifies the size of the color table used to optimize performance of the system color palettes. If biBitCount equals 16 or 32, the optimal color palette starts immediately following the three DWORD masks.
|
|
|
1025 When the bitmap array immediately follows the BITMAPINFO structure, it is a packed bitmap. Packed bitmaps are referenced by a single pointer. Packed bitmaps require that the biClrUsed member must be either zero or the actual size of the color table.
|
|
|
1026 </summary>
|
|
|
1027 </member>
|
|
|
1028 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER.biClrImportant">
|
|
|
1029 <summary>
|
|
|
1030 Specifies the number of color indexes that are required for displaying the bitmap. If this value is zero, all colors are required.
|
|
|
1031 </summary>
|
|
|
1032 </member>
|
|
|
1033 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO">
|
|
|
1034 <summary>
|
|
|
1035 The BITMAPINFO structure defines the dimensions and color information for a DIB.
|
|
|
1036 </summary>
|
|
|
1037 </member>
|
|
|
1038 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO.bmiHeader">
|
|
|
1039 <summary>
|
|
|
1040 Specifies a <see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER"/> structure that contains information about the dimensions of color format.
|
|
|
1041 </summary>
|
|
|
1042 </member>
|
|
|
1043 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO.bmiColors">
|
|
|
1044 <summary>
|
|
|
1045 <c>Null</c>, unless you're using a palette.
|
|
|
1046 </summary>
|
|
|
1047 </member>
|
|
|
1048 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION">
|
|
|
1049 <summary>
|
|
|
1050 The BLENDFUNCTION structure controls blending by specifying the blending functions for source and destination bitmaps.
|
|
|
1051 </summary>
|
|
|
1052 </member>
|
|
|
1053 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.BlendOp">
|
|
|
1054 <summary>
|
|
|
1055 Specifies the source blend operation. Currently, the only source and destination blend operation that has been defined is <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.AC_SRC_OVER"/>. For details, see the following Remarks section.
|
|
|
1056 </summary>
|
|
|
1057 </member>
|
|
|
1058 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.BlendFlags">
|
|
|
1059 <summary>
|
|
|
1060 Must be zero.
|
|
|
1061 </summary>
|
|
|
1062 </member>
|
|
|
1063 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.SourceConstantAlpha">
|
|
|
1064 <summary>
|
|
|
1065 Specifies an alpha transparency value to be used on the entire source bitmap. The SourceConstantAlpha value is combined with any per-pixel alpha values in the source bitmap. If you set SourceConstantAlpha to 0, it is assumed that your image is transparent. Set the SourceConstantAlpha value to 255 (opaque) when you only want to use per-pixel alpha values.
|
|
|
1066 </summary>
|
|
|
1067 </member>
|
|
|
1068 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.AlphaFormat">
|
|
|
1069 <summary>
|
|
|
1070 This member controls the way the source and destination bitmaps are interpreted. AlphaFormat has the following value.
|
|
|
1071 <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.AC_SRC_ALPHA"/> -> This flag is set when the bitmap has an Alpha channel (that is, per-pixel alpha). Note that the APIs use premultiplied alpha, which means that the red, green and blue channel values in the bitmap must be premultiplied with the alpha channel value. For example, if the alpha channel value is x, the red, green and blue channels must be multiplied by x and divided by 0xff prior to the call.
|
|
|
1072 </summary>
|
|
|
1073 </member>
|
|
|
1074 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.GetPerPixelBlender(System.Byte)">
|
|
|
1075 <summary>
|
|
|
1076 Gets such a structure that supports per-pixel blending and applies an additional constant alpha to the whole bitmap (set <c>255</c> for no constant alpha, just per-pixel).
|
|
|
1077 </summary>
|
|
|
1078 </member>
|
|
|
1079 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.GetPerPixelBlender">
|
|
|
1080 <summary>
|
|
|
1081 Gets a per-pixel blender without uniform transparency.
|
|
|
1082 </summary>
|
|
|
1083 </member>
|
|
|
1084 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.GetUniformBlender(System.Byte)">
|
|
|
1085 <summary>
|
|
|
1086 Gets such a structure that supports uniform transparency only.
|
|
|
1087 </summary>
|
|
|
1088 </member>
|
|
|
1089 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION.GetUniformBlender">
|
|
|
1090 <summary>
|
|
|
1091 Gets an opaque blender that ignores per-pixel alpha and has no uniform transparency.
|
|
|
1092 </summary>
|
|
|
1093 </member>
|
|
|
1094 <member name="T:JetBrains.Interop.WinApi.Advapi32Dll">
|
|
|
1095 <summary>
|
|
|
1096 User32.dll functions.
|
|
|
1097 Must be 64bit-safe.
|
|
|
1098 </summary>
|
|
|
1099 <remarks>
|
|
|
1100 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
1101 (1) All the function declarations MUST be 64-bit aware.
|
|
|
1102 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
1103 and you MUST ensure that each parameter has a proper size.
|
|
|
1104 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
1105 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
1106 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
1107 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
1108 but slows down the execution of critical members.
|
|
|
1109 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
1110 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
1111 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
1112 This greately improves the understanding of the parameter sizes.
|
|
|
1113 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
1114 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
1115 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
1116 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
1117 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
1118 (A) Same rules must apply to members of the structures.
|
|
|
1119 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
1120 </remarks>
|
|
|
1121 </member>
|
|
|
1122 <member name="M:JetBrains.Interop.WinApi.Advapi32Dll.RegCreateKeyExW(System.Void*,System.String,System.UInt32,System.String,System.UInt32,System.UInt32,System.Void*,System.Void**,System.UInt32*)">
|
|
|
1123 <remarks>samDesired is of type REGSAM which is ACCESS_FLAGS which is a DWORD</remarks>
|
|
|
1124 </member>
|
|
|
1125 <member name="M:JetBrains.Interop.WinApi.Advapi32Dll.RegDeleteKeyExW(System.Void*,System.String,System.UInt32,System.UInt32)">
|
|
|
1126 <remarks>samDesired is of type REGSAM which is ACCESS_FLAGS which is a DWORD</remarks>
|
|
|
1127 </member>
|
|
|
1128 <member name="M:JetBrains.Interop.WinApi.Advapi32Dll.RegOpenKeyExW(System.Void*,System.String,System.UInt32,System.UInt32,System.Void**)">
|
|
|
1129 <remarks>samDesired is of type REGSAM which is ACCESS_FLAGS which is a DWORD</remarks>
|
|
|
1130 </member>
|
|
|
1131 <member name="T:JetBrains.Interop.WinApi.AccessRights">
|
|
|
1132 <remarks>
|
|
|
1133 <code>
|
|
|
1134 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
|
|
|
1135 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
|
|
|
1136 +---------------+---------------+-------------------------------+
|
|
|
1137 |G|G|G|G|Res'd|A| StandardRights| SpecificRights |
|
|
|
1138 |R|W|E|A| |S| | |
|
|
|
1139 +-+-------------+---------------+-------------------------------+
|
|
|
1140 </code>
|
|
|
1141 </remarks>
|
|
|
1142 </member>
|
|
|
1143 <member name="T:JetBrains.Interop.WinApi.CombineRgnStyles">
|
|
|
1144 <summary>
|
|
|
1145 Specifies the operation to be performed over the regions.
|
|
|
1146 </summary>
|
|
|
1147 </member>
|
|
|
1148 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_AND">
|
|
|
1149 <summary>
|
|
|
1150 The new clipping region combines the overlapping areas of the current clipping region and the region identified by hrgn.
|
|
|
1151 </summary>
|
|
|
1152 </member>
|
|
|
1153 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_OR">
|
|
|
1154 <summary>
|
|
|
1155 The new clipping region is a copy of the region identified by hrgn. This is identical to SelectClipRgn. If the region identified by hrgn is NULL, the new clipping region is the default clipping region (the default clipping region is a null region).
|
|
|
1156 </summary>
|
|
|
1157 </member>
|
|
|
1158 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_XOR">
|
|
|
1159 <summary>
|
|
|
1160 The new clipping region combines the areas of the current clipping region with those areas excluded from the region identified by hrgn.
|
|
|
1161 </summary>
|
|
|
1162 </member>
|
|
|
1163 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_DIFF">
|
|
|
1164 <summary>
|
|
|
1165 The new clipping region combines the current clipping region and the region identified by hrgn.
|
|
|
1166 </summary>
|
|
|
1167 </member>
|
|
|
1168 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_COPY">
|
|
|
1169 <summary>
|
|
|
1170 The new clipping region combines the current clipping region and the region identified by hrgn but excludes any overlapping areas.
|
|
|
1171 </summary>
|
|
|
1172 </member>
|
|
|
1173 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_MIN">
|
|
|
1174 <summary>
|
|
|
1175 Same as <see cref="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_AND"/>.
|
|
|
1176 </summary>
|
|
|
1177 </member>
|
|
|
1178 <member name="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_MAX">
|
|
|
1179 <summary>
|
|
|
1180 Same as <see cref="F:JetBrains.Interop.WinApi.CombineRgnStyles.RGN_COPY"/>.
|
|
|
1181 </summary>
|
|
|
1182 </member>
|
|
|
1183 <member name="T:JetBrains.Interop.WinApi.CorSymSearchPolicyAttributes">
|
|
|
1184 <summary>
|
|
|
1185 Specifies the policy to be used when doing a search for a symbol reader.
|
|
|
1186 </summary>
|
|
|
1187 </member>
|
|
|
1188 <member name="F:JetBrains.Interop.WinApi.CorSymSearchPolicyAttributes.AllowRegistryAccess">
|
|
|
1189 <summary>
|
|
|
1190 Queries the registry for symbol search paths.
|
|
|
1191 </summary>
|
|
|
1192 </member>
|
|
|
1193 <member name="F:JetBrains.Interop.WinApi.CorSymSearchPolicyAttributes.AllowSymbolServerAccess">
|
|
|
1194 <summary>
|
|
|
1195 Accesses a symbol server.
|
|
|
1196 </summary>
|
|
|
1197 </member>
|
|
|
1198 <member name="F:JetBrains.Interop.WinApi.CorSymSearchPolicyAttributes.AllowOriginalPathAccess">
|
|
|
1199 <summary>
|
|
|
1200 Searches the path specified in the Debug directory.
|
|
|
1201 </summary>
|
|
|
1202 </member>
|
|
|
1203 <member name="F:JetBrains.Interop.WinApi.CorSymSearchPolicyAttributes.AllowReferencePathAccess">
|
|
|
1204 <summary>
|
|
|
1205 Searches for the PDB in the place where the .exe file is.
|
|
|
1206 </summary>
|
|
|
1207 </member>
|
|
|
1208 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.OBJID">
|
|
|
1209 <summary>
|
|
|
1210 Reserved IDs for system objects. See <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_GETOBJECT"/>.
|
|
|
1211 </summary>
|
|
|
1212 </member>
|
|
|
1213 <member name="T:JetBrains.Interop.WinApi.PDTIMER_FLAGS">
|
|
|
1214 <summary>
|
|
|
1215 // Time Actions (dwTimerAction)
|
|
|
1216 </summary>
|
|
|
1217 </member>
|
|
|
1218 <member name="F:JetBrains.Interop.WinApi.PDTIMER_FLAGS.PDTIMER_RESET">
|
|
|
1219 <summary>
|
|
|
1220 // Reset the timer so the progress will be calculated from now until the first ::SetProgress() is called so those this time will correspond to the values passed to ::SetProgress(). Only do this before ::SetProgress() is called.
|
|
|
1221 </summary>
|
|
|
1222 </member>
|
|
|
1223 <member name="F:JetBrains.Interop.WinApi.PDTIMER_FLAGS.PDTIMER_PAUSE">
|
|
|
1224 <summary>
|
|
|
1225 Progress has been suspended.
|
|
|
1226 </summary>
|
|
|
1227 </member>
|
|
|
1228 <member name="F:JetBrains.Interop.WinApi.PDTIMER_FLAGS.PDTIMER_RESUME">
|
|
|
1229 <summary>
|
|
|
1230 Progress has resumed.
|
|
|
1231 </summary>
|
|
|
1232 </member>
|
|
|
1233 <member name="T:JetBrains.Interop.WinApi.PROGDLG_FLAGS">
|
|
|
1234 <summary>
|
|
|
1235 // Flags for IProgressDialog::StartProgressDialog() (dwFlags)
|
|
|
1236 </summary>
|
|
|
1237 </member>
|
|
|
1238 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_NORMAL">
|
|
|
1239 <summary>
|
|
|
1240 default normal progress dlg behavior
|
|
|
1241 </summary>
|
|
|
1242 </member>
|
|
|
1243 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_MODAL">
|
|
|
1244 <summary>
|
|
|
1245 the dialog is modal to its hwndParent (default is modeless)
|
|
|
1246 </summary>
|
|
|
1247 </member>
|
|
|
1248 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_AUTOTIME">
|
|
|
1249 <summary>
|
|
|
1250 automatically updates the "Line3" text with the "time remaining" (you cant call SetLine3 if you passs this!)
|
|
|
1251 </summary>
|
|
|
1252 </member>
|
|
|
1253 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_NOTIME">
|
|
|
1254 <summary>
|
|
|
1255 we dont show the "time remaining" if this is set. We need this if dwTotal < dwCompleted for sparse files
|
|
|
1256 </summary>
|
|
|
1257 </member>
|
|
|
1258 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_NOMINIMIZE">
|
|
|
1259 <summary>
|
|
|
1260 Do not have a minimize button in the caption bar.
|
|
|
1261 </summary>
|
|
|
1262 </member>
|
|
|
1263 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_NOPROGRESSBAR">
|
|
|
1264 <summary>
|
|
|
1265 Don't display the progress bar
|
|
|
1266 </summary>
|
|
|
1267 </member>
|
|
|
1268 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_MARQUEEPROGRESS">
|
|
|
1269 <summary>
|
|
|
1270 Use marquee progress (comctl32 v6 required)
|
|
|
1271 </summary>
|
|
|
1272 </member>
|
|
|
1273 <member name="F:JetBrains.Interop.WinApi.PROGDLG_FLAGS.PROGDLG_NOCANCEL">
|
|
|
1274 <summary>
|
|
|
1275 No cancel button (operation cannot be canceled) (use sparingly)
|
|
|
1276 </summary>
|
|
|
1277 </member>
|
|
|
1278 <member name="T:JetBrains.Interop.WinApi.DialogBoxCommandId">
|
|
|
1279 <summary>
|
|
|
1280 Standard command IDs for the dialog boxes.
|
|
|
1281 </summary>
|
|
|
1282 </member>
|
|
|
1283 <member name="T:JetBrains.Interop.WinApi.DialogCodes">
|
|
|
1284 <summary>
|
|
|
1285 Dialog Codes.
|
|
|
1286 </summary>
|
|
|
1287 </member>
|
|
|
1288 <member name="T:JetBrains.Interop.WinApi.MessageBoxFlags">
|
|
|
1289 <summary>
|
|
|
1290 Flags for the <see cref="M:JetBrains.Interop.WinApi.User32Dll.MessageBoxW(System.Void*,System.String,System.String,System.UInt32)"/> function.
|
|
|
1291 </summary>
|
|
|
1292 </member>
|
|
|
1293 <member name="T:JetBrains.Interop.WinApi.OleCmdErr">
|
|
|
1294 <summary>
|
|
|
1295 OLE CMD Errors from <c>DocObj.h</c>.
|
|
|
1296 </summary>
|
|
|
1297 </member>
|
|
|
1298 <member name="F:JetBrains.Interop.WinApi.ProcessorArchitecture.PROCESSOR_ARCHITECTURE_INTEL">
|
|
|
1299 <summary>
|
|
|
1300 x86
|
|
|
1301 </summary>
|
|
|
1302 </member>
|
|
|
1303 <member name="F:JetBrains.Interop.WinApi.ProcessorArchitecture.PROCESSOR_ARCHITECTURE_IA64">
|
|
|
1304 <summary>
|
|
|
1305 Intel Itanium-based
|
|
|
1306 </summary>
|
|
|
1307 </member>
|
|
|
1308 <member name="F:JetBrains.Interop.WinApi.ProcessorArchitecture.PROCESSOR_ARCHITECTURE_AMD64">
|
|
|
1309 <summary>
|
|
|
1310 x64 (AMD or Intel)
|
|
|
1311 </summary>
|
|
|
1312 </member>
|
|
|
1313 <member name="F:JetBrains.Interop.WinApi.ProcessorArchitecture.PROCESSOR_ARCHITECTURE_UNKNOWN">
|
|
|
1314 <summary>
|
|
|
1315 Unknown architecture.
|
|
|
1316 </summary>
|
|
|
1317 </member>
|
|
|
1318 <member name="T:JetBrains.Interop.WinApi.SystemMetricsCodes">
|
|
|
1319 <summary>
|
|
|
1320 Codes for the <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetSystemMetrics(System.Int32)"/> function.
|
|
|
1321 </summary>
|
|
|
1322 </member>
|
|
|
1323 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.WaitResult">
|
|
|
1324 <summary>
|
|
|
1325 Result flags for the wait functions.
|
|
|
1326 </summary>
|
|
|
1327 </member>
|
|
|
1328 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.WaitResult.WAIT_ABANDONED">
|
|
|
1329 <summary>
|
|
|
1330 The specified object is a mutex object that was not released by the thread that owned the mutex object before the owning thread terminated. Ownership of the mutex object is granted to the calling thread, and the mutex is set to nonsignaled.
|
|
|
1331 If the mutex was protecting persistent state information, you should check it for consistency.
|
|
|
1332 </summary>
|
|
|
1333 </member>
|
|
|
1334 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.WaitResult.WAIT_OBJECT_0">
|
|
|
1335 <summary>
|
|
|
1336 The state of the specified object is signaled.
|
|
|
1337 </summary>
|
|
|
1338 </member>
|
|
|
1339 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.WaitResult.WAIT_TIMEOUT">
|
|
|
1340 <summary>
|
|
|
1341 The time-out interval elapsed, and the object's state is nonsignaled.
|
|
|
1342 </summary>
|
|
|
1343 </member>
|
|
|
1344 <!-- Badly formed XML comment ignored for member "T:JetBrains.Interop.WinApi.Interfaces.IProgressDialog" -->
|
|
|
1345 <member name="T:JetBrains.Interop.WinApi.Declarations.Interfaces.IServiceProvider">
|
|
|
1346 <summary>
|
|
|
1347 <para>The IServiceProvider interface is a generic access mechanism to locate a GUID-identified service that is provided through a control or any other object that the service can communicate with. For example, an embedded object (such as an OLE control) typically communicates only with its associated client site object in the container through the IOleClientSite interface that is supplied by using IOleObject::SetClientSite. The embedded object must ask the client site for some other service that the container supports when that service might not be implemented in the client site.</para>
|
|
|
1348 <para>The client site must provide a means by which the control that is managed by the site can access the service when necessary. For example, the IOleInPlaceSite::GetWindowContext function can be used by an in-place object or control to access interface pointers for the document object that contains the site and the frame object that contains the document. Because these interface pointers exist on separate objects, the control cannot call the site's QueryInterface to obtain those pointers. Instead, use the IServiceProvider interface. </para>
|
|
|
1349 <para>The IServiceProvider interface has only one member, QueryService, through which a caller specifies the service ID (SID, a GUID), the IID of the interface to return, and the address of the caller's interface pointer variable. </para>
|
|
|
1350 </summary>
|
|
|
1351 </member>
|
|
|
1352 <member name="M:JetBrains.Interop.WinApi.Declarations.Interfaces.IServiceProvider.QueryService(System.Guid*,System.Guid*)">
|
|
|
1353 <summary>
|
|
|
1354 Acts as the factory method for any services exposed through an implementation of IServiceProvider.
|
|
|
1355 </summary>
|
|
|
1356 <param name="guidService">[in] The unique identifier of the service (an SID). </param>
|
|
|
1357 <param name="riid">[in] The unique identifier of the interface that the caller wants to receive for the service. </param>
|
|
|
1358 <returns>[out] The address of the caller-allocated variable to receive the interface pointer of the service on successful return from this function. The caller becomes responsible for calling Release through this interface pointer when the service is no longer required.</returns>
|
|
|
1359 </member>
|
|
|
1360 <member name="T:JetBrains.Interop.WinApi.Macros">
|
|
|
1361 <summary>
|
|
|
1362 Hosts the scattered WinAPI macros, in the form of functions.
|
|
|
1363 </summary>
|
|
|
1364 </member>
|
|
|
1365 <member name="M:JetBrains.Interop.WinApi.Macros.GET_X_LPARAM(System.IntPtr)">
|
|
|
1366 <summary>
|
|
|
1367 Gets a signed x-coordinate packed into an LPARAM, usually in Windows messgaes.
|
|
|
1368 To create a point from an LPARAM, use casting thru the <see cref="T:JetBrains.Interop.WinApi.POINT"/> class.
|
|
|
1369 </summary>
|
|
|
1370 </member>
|
|
|
1371 <member name="M:JetBrains.Interop.WinApi.Macros.GET_Y_LPARAM(System.IntPtr)">
|
|
|
1372 <summary>
|
|
|
1373 Gets a signed y-coordinate packed into an LPARAM, usually in Windows messgaes.
|
|
|
1374 To create a point from an LPARAM, use casting thru the <see cref="T:JetBrains.Interop.WinApi.POINT"/> class.
|
|
|
1375 </summary>
|
|
|
1376 </member>
|
|
|
1377 <member name="M:JetBrains.Interop.WinApi.Macros.MAKEDWORD(System.UInt16,System.UInt16)">
|
|
|
1378 <summary>
|
|
|
1379 In WinAPI, this is called <c>MAKELONG</c> (C's <c>long</c> is of the same size as a DWORD, whilst in C# it's a QWORD).
|
|
|
1380 </summary>
|
|
|
1381 </member>
|
|
|
1382 <member name="T:JetBrains.Interop.WinApi.MsImg32Dll">
|
|
|
1383 <summary>
|
|
|
1384 MsImg32.dll functions.
|
|
|
1385 Must be 64bit-safe.
|
|
|
1386 </summary>
|
|
|
1387 <remarks>
|
|
|
1388 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
1389 (1) All the function declarations MUST be 64-bit aware.
|
|
|
1390 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
1391 and you MUST ensure that each parameter has a proper size.
|
|
|
1392 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
1393 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
1394 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
1395 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
1396 but slows down the execution of critical members.
|
|
|
1397 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
1398 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
1399 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
1400 This greately improves the understanding of the parameter sizes.
|
|
|
1401 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
1402 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
1403 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
1404 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
1405 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
1406 (A) Same rules must apply to members of the structures.
|
|
|
1407 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
1408 </remarks>
|
|
|
1409 </member>
|
|
|
1410 <member name="M:JetBrains.Interop.WinApi.MsImg32Dll.AlphaBlend(System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION)">
|
|
|
1411 <summary>
|
|
|
1412 The AlphaBlend function displays bitmaps that have transparent or semitransparent pixels.
|
|
|
1413 </summary>
|
|
|
1414 <param name="hdcDest">
|
|
|
1415 [in] Handle to the destination device context. </param>
|
|
|
1416 <param name="nXOriginDest">
|
|
|
1417 [in] Specifies the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. </param>
|
|
|
1418 <param name="nYOriginDest">
|
|
|
1419 [in] Specifies the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. </param>
|
|
|
1420 <param name="nWidthDest">
|
|
|
1421 [in] Specifies the width, in logical units, of the destination rectangle. </param>
|
|
|
1422 <param name="nHeightDest">
|
|
|
1423 [in] Specifies the height, in logical units, of the destination rectangle. </param>
|
|
|
1424 <param name="hdcSrc">
|
|
|
1425 [in] Handle to the source device context. </param>
|
|
|
1426 <param name="nXOriginSrc">
|
|
|
1427 [in] Specifies the x-coordinate, in logical units, of the upper-left corner of the source rectangle. </param>
|
|
|
1428 <param name="nYOriginSrc">
|
|
|
1429 [in] Specifies the y-coordinate, in logical units, of the upper-left corner of the source rectangle. </param>
|
|
|
1430 <param name="nWidthSrc">
|
|
|
1431 [in] Specifies the width, in logical units, of the source rectangle. </param>
|
|
|
1432 <param name="nHeightSrc">
|
|
|
1433 [in] Specifies the height, in logical units, of the source rectangle. </param>
|
|
|
1434 <param name="blendFunction">
|
|
|
1435 [in] Specifies the alpha-blending function for source and destination bitmaps, a global alpha value to be applied to the entire source bitmap, and format information for the source bitmap. The source and destination blend functions are currently limited to AC_SRC_OVER. See the <see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION"/> and EMRALPHABLEND structures. </param>
|
|
|
1436 <returns>If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE.</returns>
|
|
|
1437 </member>
|
|
|
1438 <member name="T:JetBrains.Interop.WinApi.Ole32Dll">
|
|
|
1439 <summary>
|
|
|
1440 Ole32.dll functions.
|
|
|
1441 Must be 64bit-safe.
|
|
|
1442 </summary>
|
|
|
1443 <remarks>
|
|
|
1444 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
1445 (1) All the function declarations MUST be 64-bit aware.
|
|
|
1446 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
1447 and you MUST ensure that each parameter has a proper size.
|
|
|
1448 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
1449 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
1450 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
1451 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
1452 but slows down the execution of critical members.
|
|
|
1453 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
1454 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
1455 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
1456 This greately improves the understanding of the parameter sizes.
|
|
|
1457 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
1458 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
1459 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
1460 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
1461 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
1462 (A) Same rules must apply to members of the structures.
|
|
|
1463 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
1464 </remarks>
|
|
|
1465 </member>
|
|
|
1466 <member name="T:JetBrains.Interop.WinApi.OleAut32Dll">
|
|
|
1467 <summary>
|
|
|
1468 OleAut32.dll functions.
|
|
|
1469 Must be 64bit-safe.
|
|
|
1470 </summary>
|
|
|
1471 <remarks>
|
|
|
1472 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
1473 (1) All the function declarations MUST be 64-bit aware.
|
|
|
1474 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
1475 and you MUST ensure that each parameter has a proper size.
|
|
|
1476 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
1477 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
1478 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
1479 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
1480 but slows down the execution of critical members.
|
|
|
1481 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
1482 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
1483 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
1484 This greately improves the understanding of the parameter sizes.
|
|
|
1485 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
1486 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
1487 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
1488 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
1489 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
1490 (A) Same rules must apply to members of the structures.
|
|
|
1491 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
1492 </remarks>
|
|
|
1493 </member>
|
|
|
1494 <member name="M:JetBrains.Interop.WinApi.OleAut32Dll.VariantClear(System.Void*)">
|
|
|
1495 <summary>
|
|
|
1496 Clears a variant.
|
|
|
1497 </summary>
|
|
|
1498 <param name="pvarg">Pointer to the <c>VARIANTARG</c> to clear.</param>
|
|
|
1499 <returns>The return value obtained from the returned HRESULT is one of the following.</returns>
|
|
|
1500 <remarks>
|
|
|
1501 Use this function to clear variables of type VARIANTARG (or VARIANT) before the memory containing the VARIANTARG is freed (as when a local variable goes out of scope).
|
|
|
1502
|
|
|
1503 The function clears a VARIANTARG by setting the vt field to VT_EMPTY. The current contents of the VARIANTARG are released first. If the vtfield is VT_BSTR, the string is freed. If the vtfield is VT_DISPATCH, the object is released. If the vt field has the VT_ARRAY bit set, the array is freed.
|
|
|
1504
|
|
|
1505 If the variant to be cleared is a COM object that is passed by reference, the vtfield of the pvargparameter is VT_DISPATCH | VT_BYREF or VT_UNKNOWN | VT_BYREF. In this case, VariantClear does not release the object. Because the variant being cleared is a pointer to a reference to an object, VariantClear has no way to determine if it is necessary to release the object. It is therefore the responsibility of the caller to release the object or not, as appropriate.
|
|
|
1506
|
|
|
1507 In certain cases, it may be preferable to clear a variant in code without calling VariantClear. For example, you can change the type of a VT_I4 variant to another type without calling this function. Safearrays of BSTR will have SysFreeString called on each element not VariantClear. However, you must call VariantClear if a VT_type is received but cannot be handled. Safearrays of variant will also have VariantClear called on each member. Using VariantClear in these cases ensures that code will continue to work if Automation adds new variant types in the future.
|
|
|
1508
|
|
|
1509 Do not use VariantClear on unitialized variants; use VariantInit to initialize a new VARIANTARG or VARIANT.
|
|
|
1510
|
|
|
1511 Variants containing arrays with outstanding references cannot be cleared. Attempts to do so will return an HRESULT containing DISP_E_ARRAYISLOCKED.
|
|
|
1512 </remarks>
|
|
|
1513 </member>
|
|
|
1514 <member name="M:JetBrains.Interop.WinApi.OleAut32Dll.VariantInit(System.Void*)">
|
|
|
1515 <summary>
|
|
|
1516 Initializes a variant.
|
|
|
1517 </summary>
|
|
|
1518 <param name="pvarg">Pointer to the VARIANTARG that will be initialized.</param>
|
|
|
1519 <remarks>The VariantInit function initializes the VARIANTARG by setting the vt field to VT_EMPTY. Unlike VariantClear, this function does not interpret the current contents of the VARIANTARG. Use VariantInit to initialize new local variables of type VARIANTARG (or VARIANT). </remarks>
|
|
|
1520 </member>
|
|
|
1521 <member name="M:JetBrains.Interop.WinApi.Shell32Dll.SHGetFileInfoW(System.String,System.UInt32,JetBrains.Interop.WinApi.SHFILEINFO*,System.UInt32,System.UInt32)">
|
|
|
1522 <summary>
|
|
|
1523 Retrieves information about an object in the file system, such as a file, folder, directory, or drive root.
|
|
|
1524 </summary>
|
|
|
1525 <param name="pszPath">Type: LPCTSTR A pointer to a null-terminated string of maximum length MAX_PATH that contains the path and file name. Both absolute and relative paths are valid. If the uFlags parameter includes the SHGFI_PIDL flag, this parameter must be the address of an ITEMIDLIST (PIDL) structure that contains the list of item identifiers that uniquely identifies the file within the Shell's namespace. The PIDL must be a fully qualified PIDL. Relative PIDLs are not allowed. If the uFlags parameter includes the SHGFI_USEFILEATTRIBUTES flag, this parameter does not have to be a valid file name. The function will proceed as if the file exists with the specified name and with the file attributes passed in the dwFileAttributes parameter. This allows you to obtain information about a file type by passing just the extension for pszPath and passing FILE_ATTRIBUTE_NORMAL in dwFileAttributes. This string can use either short (the 8.3 form) or long file names.</param>
|
|
|
1526 <param name="dwFileAttributes">A combination of one or more file attribute flags (FILE_ATTRIBUTE_ values as defined in Winnt.h). If uFlags does not include the SHGFI_USEFILEATTRIBUTES flag, this parameter is ignored.</param>
|
|
|
1527 <param name="psfi">Pointer to a SHFILEINFO structure to receive the file information.</param>
|
|
|
1528 <param name="cbFileInfo">The size, in bytes, of the SHFILEINFO structure pointed to by the psfi parameter.</param>
|
|
|
1529 <param name="uFlags">The flags that specify the file information to retrieve. This parameter can be a combination of the following values. <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.SHGetFileInfoFlags"/>.</param>
|
|
|
1530 <returns>Returns a value whose meaning depends on the uFlags parameter. If uFlags does not contain SHGFI_EXETYPE or SHGFI_SYSICONINDEX, the return value is nonzero if successful, or zero otherwise. If uFlags contains the SHGFI_EXETYPE flag, the return value specifies the type of the executable file. It will be one of the following values.</returns>
|
|
|
1531 </member>
|
|
|
1532 <member name="M:JetBrains.Interop.WinApi.SHFolderDll.SHGetFolderPathW(System.Void*,System.Int32,System.Void*,System.UInt32,System.Text.StringBuilder)">
|
|
|
1533 <param name="hwndOwner"></param>
|
|
|
1534 <param name="nFolder"><see cref="T:JetBrains.Interop.WinApi.CSIDL"/></param>
|
|
|
1535 <param name="hToken"></param>
|
|
|
1536 <param name="dwFlags"><see cref="T:JetBrains.Interop.WinApi.SHGFP_TYPE"/></param>
|
|
|
1537 <param name="lpszPath"></param>
|
|
|
1538 </member>
|
|
|
1539 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO">
|
|
|
1540 <summary>
|
|
|
1541 The CURSORINFO structure contains global cursor information.
|
|
|
1542 </summary>
|
|
|
1543 </member>
|
|
|
1544 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO.cbSize">
|
|
|
1545 <summary>
|
|
|
1546 Specifies the size, in bytes, of the structure. The caller must set this to <c>sizeof(CURSORINFO)</c>.
|
|
|
1547 </summary>
|
|
|
1548 </member>
|
|
|
1549 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO.flags">
|
|
|
1550 <summary>
|
|
|
1551 Specifies the cursor state. This parameter can be one of the following values.
|
|
|
1552 • 0 — The cursor is hidden.
|
|
|
1553 • CURSOR_SHOWING — The cursor is showing.
|
|
|
1554 </summary>
|
|
|
1555 </member>
|
|
|
1556 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO.hCursor">
|
|
|
1557 <summary>
|
|
|
1558 Handle to the cursor.
|
|
|
1559 </summary>
|
|
|
1560 </member>
|
|
|
1561 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO.ptScreenPos">
|
|
|
1562 <summary>
|
|
|
1563 A <see cref="T:JetBrains.Interop.WinApi.POINT"/> structure that receives the screen coordinates of the cursor.
|
|
|
1564 </summary>
|
|
|
1565 </member>
|
|
|
1566 <member name="T:JetBrains.Interop.WinApi.CWPRETSTRUCT">
|
|
|
1567 <summary>
|
|
|
1568 The CWPRETSTRUCT structure defines the message parameters passed to a WH_CALLWNDPROCRET hook procedure, CallWndRetProc.
|
|
|
1569 </summary>
|
|
|
1570 </member>
|
|
|
1571 <member name="F:JetBrains.Interop.WinApi.CWPRETSTRUCT.lResult">
|
|
|
1572 <summary>
|
|
|
1573 Specifies the return value of the window procedure that processed the message specified by the message value.
|
|
|
1574 </summary>
|
|
|
1575 </member>
|
|
|
1576 <member name="F:JetBrains.Interop.WinApi.CWPRETSTRUCT.lParam">
|
|
|
1577 <summary>
|
|
|
1578 Specifies additional information about the message. The exact meaning depends on the message value.
|
|
|
1579 </summary>
|
|
|
1580 </member>
|
|
|
1581 <member name="F:JetBrains.Interop.WinApi.CWPRETSTRUCT.wParam">
|
|
|
1582 <summary>
|
|
|
1583 Specifies additional information about the message. The exact meaning depends on the message value.
|
|
|
1584 </summary>
|
|
|
1585 </member>
|
|
|
1586 <member name="F:JetBrains.Interop.WinApi.CWPRETSTRUCT.message">
|
|
|
1587 <summary>
|
|
|
1588 Specifies the message.
|
|
|
1589 </summary>
|
|
|
1590 </member>
|
|
|
1591 <member name="F:JetBrains.Interop.WinApi.CWPRETSTRUCT.hwnd">
|
|
|
1592 <summary>
|
|
|
1593 Handle to the window that processed the message specified by the message value.
|
|
|
1594 </summary>
|
|
|
1595 </member>
|
|
|
1596 <member name="T:JetBrains.Interop.WinApi.CWPSTRUCT">
|
|
|
1597 <summary>
|
|
|
1598 The CWPSTRUCT structure defines the message parameters passed to a WH_CALLWNDPROC hook procedure, CallWndProc.
|
|
|
1599 </summary>
|
|
|
1600 </member>
|
|
|
1601 <member name="F:JetBrains.Interop.WinApi.CWPSTRUCT.lParam">
|
|
|
1602 <summary>
|
|
|
1603 Specifies additional information about the message. The exact meaning depends on the message value.
|
|
|
1604 </summary>
|
|
|
1605 </member>
|
|
|
1606 <member name="F:JetBrains.Interop.WinApi.CWPSTRUCT.wParam">
|
|
|
1607 <summary>
|
|
|
1608 Specifies additional information about the message. The exact meaning depends on the message value.
|
|
|
1609 </summary>
|
|
|
1610 </member>
|
|
|
1611 <member name="F:JetBrains.Interop.WinApi.CWPSTRUCT.message">
|
|
|
1612 <summary>
|
|
|
1613 Specifies the message.
|
|
|
1614 </summary>
|
|
|
1615 </member>
|
|
|
1616 <member name="F:JetBrains.Interop.WinApi.CWPSTRUCT.hwnd">
|
|
|
1617 <summary>
|
|
|
1618 Handle to the window to receive the message.
|
|
|
1619 </summary>
|
|
|
1620 </member>
|
|
|
1621 <member name="T:JetBrains.Interop.WinApi.GUITHREADINFO">
|
|
|
1622 <summary>
|
|
|
1623 The GUITHREADINFO structure contains information about a graphical user interface (GUI) thread.
|
|
|
1624 </summary>
|
|
|
1625 </member>
|
|
|
1626 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.cbSize">
|
|
|
1627 <summary>
|
|
|
1628 Specifies the size of this structure, in bytes. The caller must set this to sizeof(GUITHREADINFO).
|
|
|
1629 </summary>
|
|
|
1630 </member>
|
|
|
1631 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.flags">
|
|
|
1632 <summary>
|
|
|
1633 Specifies the thread state.
|
|
|
1634 </summary>
|
|
|
1635 </member>
|
|
|
1636 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndActive">
|
|
|
1637 <summary>
|
|
|
1638 Handle to the active window within the thread.
|
|
|
1639 </summary>
|
|
|
1640 </member>
|
|
|
1641 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndFocus">
|
|
|
1642 <summary>
|
|
|
1643 Handle to the window that has the keyboard focus.
|
|
|
1644 </summary>
|
|
|
1645 </member>
|
|
|
1646 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndCapture">
|
|
|
1647 <summary>
|
|
|
1648 Handle to the window that has captured the mouse.
|
|
|
1649 </summary>
|
|
|
1650 </member>
|
|
|
1651 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndMenuOwner">
|
|
|
1652 <summary>
|
|
|
1653 Handle to the window that owns any active menus.
|
|
|
1654 </summary>
|
|
|
1655 </member>
|
|
|
1656 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndMoveSize">
|
|
|
1657 <summary>
|
|
|
1658 Handle to the window in a move or size loop.
|
|
|
1659 </summary>
|
|
|
1660 </member>
|
|
|
1661 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.hwndCaret">
|
|
|
1662 <summary>
|
|
|
1663 Handle to the window that is displaying the caret.
|
|
|
1664 </summary>
|
|
|
1665 </member>
|
|
|
1666 <member name="F:JetBrains.Interop.WinApi.GUITHREADINFO.rcCaret">
|
|
|
1667 <summary>
|
|
|
1668 A <c>RECT</c> structure that describes the caret's bounding rectangle, in client coordinates, relative to the window specified by the hwndCaret member.
|
|
|
1669 </summary>
|
|
|
1670 </member>
|
|
|
1671 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.BaseAddress">
|
|
|
1672 <summary>
|
|
|
1673 A pointer to the base address of the region of pages.
|
|
|
1674 </summary>
|
|
|
1675 </member>
|
|
|
1676 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.AllocationBase">
|
|
|
1677 <summary>
|
|
|
1678 A pointer to the base address of a range of pages allocated by the VirtualAlloc function. The page pointed to by the BaseAddress member is contained within this allocation range.
|
|
|
1679 </summary>
|
|
|
1680 </member>
|
|
|
1681 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.AllocationProtect">
|
|
|
1682 <summary>
|
|
|
1683 The memory protection option when the region was initially allocated. This member can be one of the memory protection constants or 0 if the caller does not have access.
|
|
|
1684 </summary>
|
|
|
1685 </member>
|
|
|
1686 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.RegionSize">
|
|
|
1687 <summary>
|
|
|
1688 The size of the region beginning at the base address in which all pages have identical attributes, in bytes.
|
|
|
1689 </summary>
|
|
|
1690 </member>
|
|
|
1691 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.State">
|
|
|
1692 <summary>
|
|
|
1693 The state of the pages in the region. This member can be one of the following values: <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_COMMIT"/>, <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_RESERVE"/>, <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes.MEM_FREE"/>.
|
|
|
1694 </summary>
|
|
|
1695 </member>
|
|
|
1696 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.Protect">
|
|
|
1697 <summary>
|
|
|
1698 The access protection of the pages in the region. This member is one of the values listed for the AllocationProtect member.
|
|
|
1699 </summary>
|
|
|
1700 </member>
|
|
|
1701 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION.Type">
|
|
|
1702 <summary>
|
|
|
1703 The type of pages in the region. See <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryPageTypes"/>.
|
|
|
1704 </summary>
|
|
|
1705 </member>
|
|
|
1706 <member name="T:JetBrains.Interop.WinApi.MOUSEHOOKSTRUCT">
|
|
|
1707 <summary>
|
|
|
1708 The MOUSEHOOKSTRUCT structure contains information about a mouse event passed to a WH_MOUSE hook procedure, MouseProc.
|
|
|
1709 </summary>
|
|
|
1710 </member>
|
|
|
1711 <member name="F:JetBrains.Interop.WinApi.MOUSEHOOKSTRUCT.pt">
|
|
|
1712 <summary>
|
|
|
1713 Specifies a POINT structure that contains the x- and y-coordinates of the cursor, in screen coordinates.
|
|
|
1714 </summary>
|
|
|
1715 </member>
|
|
|
1716 <member name="F:JetBrains.Interop.WinApi.MOUSEHOOKSTRUCT.hwnd">
|
|
|
1717 <summary>
|
|
|
1718 Handle to the window that will receive the mouse message corresponding to the mouse event.
|
|
|
1719 </summary>
|
|
|
1720 </member>
|
|
|
1721 <member name="F:JetBrains.Interop.WinApi.MOUSEHOOKSTRUCT.wHitTestCode">
|
|
|
1722 <summary>
|
|
|
1723 Specifies the hit-test value. For a list of hit-test values, see the description of the WM_NCHITTEST message.
|
|
|
1724 </summary>
|
|
|
1725 </member>
|
|
|
1726 <member name="F:JetBrains.Interop.WinApi.MOUSEHOOKSTRUCT.dwExtraInfo">
|
|
|
1727 <summary>
|
|
|
1728 Specifies extra information associated with the message.
|
|
|
1729 </summary>
|
|
|
1730 </member>
|
|
|
1731 <member name="T:JetBrains.Interop.WinApi.MSG">
|
|
|
1732 <summary>
|
|
|
1733 The MSG structure contains message information from a thread's message queue.
|
|
|
1734 </summary>
|
|
|
1735 </member>
|
|
|
1736 <member name="F:JetBrains.Interop.WinApi.MSG.hwnd">
|
|
|
1737 <summary>
|
|
|
1738 Handle to the window whose window procedure receives the message. hwnd is NULL when the message is a thread message.
|
|
|
1739 </summary>
|
|
|
1740 </member>
|
|
|
1741 <member name="F:JetBrains.Interop.WinApi.MSG.message">
|
|
|
1742 <summary>
|
|
|
1743 Specifies the message identifier. Applications can only use the low word; the high word is reserved by the system.
|
|
|
1744 </summary>
|
|
|
1745 </member>
|
|
|
1746 <member name="F:JetBrains.Interop.WinApi.MSG.wParam">
|
|
|
1747 <summary>
|
|
|
1748 Specifies additional information about the message. The exact meaning depends on the value of the message member.
|
|
|
1749 </summary>
|
|
|
1750 </member>
|
|
|
1751 <member name="F:JetBrains.Interop.WinApi.MSG.lParam">
|
|
|
1752 <summary>
|
|
|
1753 Specifies additional information about the message. The exact meaning depends on the value of the message member.
|
|
|
1754 </summary>
|
|
|
1755 </member>
|
|
|
1756 <member name="F:JetBrains.Interop.WinApi.MSG.time">
|
|
|
1757 <summary>
|
|
|
1758 Specifies the time at which the message was posted.
|
|
|
1759 </summary>
|
|
|
1760 </member>
|
|
|
1761 <member name="F:JetBrains.Interop.WinApi.MSG.pt">
|
|
|
1762 <summary>
|
|
|
1763 Specifies the cursor position, in screen coordinates, when the message was posted.
|
|
|
1764 </summary>
|
|
|
1765 </member>
|
|
|
1766 <member name="T:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT">
|
|
|
1767 <summary>
|
|
|
1768 The MSLLHOOKSTRUCT structure contains information about a low-level keyboard input event.
|
|
|
1769 </summary>
|
|
|
1770 </member>
|
|
|
1771 <member name="F:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT.pt">
|
|
|
1772 <summary>
|
|
|
1773 Specifies a POINT structure that contains the x- and y-coordinates of the cursor, in screen coordinates.
|
|
|
1774 </summary>
|
|
|
1775 </member>
|
|
|
1776 <member name="F:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT.mouseData">
|
|
|
1777 <summary>
|
|
|
1778 <para>If the message is WM_MOUSEWHEEL, the high-order word of this member is the wheel delta. The low-order word is reserved. A positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user. One wheel click is defined as WHEEL_DELTA, which is 120. </para>
|
|
|
1779 <para>If the message is WM_XBUTTONDOWN, WM_XBUTTONUP, WM_XBUTTONDBLCLK, WM_NCXBUTTONDOWN, WM_NCXBUTTONUP, or WM_NCXBUTTONDBLCLK, the high-order word specifies which X button was pressed or released, and the low-order word is reserved. This value can be one or more of the following values. Otherwise, mouseData is not used.</para>
|
|
|
1780 <para>XBUTTON1 The first X button was pressed or released.</para>
|
|
|
1781 <para>XBUTTON2 The second X button was pressed or released.</para>
|
|
|
1782 </summary>
|
|
|
1783 </member>
|
|
|
1784 <member name="F:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT.flags">
|
|
|
1785 <summary>
|
|
|
1786 <para>Specifies the event-injected flag. An application can use the following value to test the mouse flags. </para>
|
|
|
1787 <para>LLMHF_INJECTED Test the event-injected flag.</para>
|
|
|
1788 <para>0 Specifies whether the event was injected. The value is 1 if the event was injected; otherwise, it is 0.</para>
|
|
|
1789 <para>1-15 Reserved.</para>
|
|
|
1790 </summary>
|
|
|
1791 </member>
|
|
|
1792 <member name="F:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT.time">
|
|
|
1793 <summary>
|
|
|
1794 Specifies the time stamp for this message.
|
|
|
1795 </summary>
|
|
|
1796 </member>
|
|
|
1797 <member name="F:JetBrains.Interop.WinApi.MSLLHOOKSTRUCT.dwExtraInfo">
|
|
|
1798 <summary>
|
|
|
1799 Specifies extra information associated with the message.
|
|
|
1800 </summary>
|
|
|
1801 </member>
|
|
|
1802 <member name="T:JetBrains.Interop.WinApi.NMHDR">
|
|
|
1803 <summary>
|
|
|
1804 Contains information about a notification message.
|
|
|
1805 </summary>
|
|
|
1806 </member>
|
|
|
1807 <member name="F:JetBrains.Interop.WinApi.NMHDR.hwndFrom">
|
|
|
1808 <summary>
|
|
|
1809 A window handle to the control sending the message.
|
|
|
1810 </summary>
|
|
|
1811 </member>
|
|
|
1812 <member name="F:JetBrains.Interop.WinApi.NMHDR.idFrom">
|
|
|
1813 <summary>
|
|
|
1814 An identifier of the control sending the message.
|
|
|
1815 </summary>
|
|
|
1816 </member>
|
|
|
1817 <member name="F:JetBrains.Interop.WinApi.NMHDR.code">
|
|
|
1818 <summary>
|
|
|
1819 A notification code. This member can be one of the common notification codes (see Notifications under General Control Reference), or it can be a control-specific notification code.
|
|
|
1820 </summary>
|
|
|
1821 </member>
|
|
|
1822 <member name="T:JetBrains.Interop.WinApi.POINT">
|
|
|
1823 <summary>
|
|
|
1824 The POINT structure defines the x- and y- coordinates of a point.
|
|
|
1825 </summary>
|
|
|
1826 </member>
|
|
|
1827 <member name="F:JetBrains.Interop.WinApi.POINT.x">
|
|
|
1828 <summary>
|
|
|
1829 Specifies the x-coordinate of the point.
|
|
|
1830 </summary>
|
|
|
1831 </member>
|
|
|
1832 <member name="F:JetBrains.Interop.WinApi.POINT.y">
|
|
|
1833 <summary>
|
|
|
1834 Specifies the y-coordinate of the point.
|
|
|
1835 </summary>
|
|
|
1836 </member>
|
|
|
1837 <member name="M:JetBrains.Interop.WinApi.POINT.#ctor(System.IntPtr)">
|
|
|
1838 <summary>
|
|
|
1839 Creates a new point, unpacking its signed coordinates from an LPARAM, using the <see cref="M:JetBrains.Interop.WinApi.Macros.GET_X_LPARAM(System.IntPtr)"/> and <see cref="M:JetBrains.Interop.WinApi.Macros.GET_Y_LPARAM(System.IntPtr)"/> functions.
|
|
|
1840 </summary>
|
|
|
1841 </member>
|
|
|
1842 <member name="M:JetBrains.Interop.WinApi.POINT.ToString">
|
|
|
1843 <summary>
|
|
|
1844 Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
1845 </summary>
|
|
|
1846
|
|
|
1847 <returns>
|
|
|
1848 A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
1849 </returns>
|
|
|
1850 <filterpriority>2</filterpriority>
|
|
|
1851 </member>
|
|
|
1852 <member name="T:JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES">
|
|
|
1853 <summary>
|
|
|
1854 The <see cref="T:JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES"/> structure contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable. This structure provides security settings for objects created by various functions, such as CreateFile, CreatePipe, CreateProcess, RegCreateKeyEx, or RegSaveKeyEx.
|
|
|
1855 </summary>
|
|
|
1856 </member>
|
|
|
1857 <member name="F:JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES.nLength">
|
|
|
1858 <summary>
|
|
|
1859 The size, in bytes, of this structure. Set this value to the size of the SECURITY_ATTRIBUTES structure.
|
|
|
1860 </summary>
|
|
|
1861 </member>
|
|
|
1862 <member name="F:JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES.lpSecurityDescriptor">
|
|
|
1863 <summary>
|
|
|
1864 A pointer to a security descriptor for the object that controls the sharing of it. If NULL is specified for this member, the object is assigned the default security descriptor of the calling process. This is not the same as granting access to everyone by assigning a NULL discretionary access control list (DACL). The default security descriptor is based on the default DACL of the access token belonging to the calling process. By default, the default DACL in the access token of a process allows access only to the user represented by the access token. If other users must access the object, you can either create a security descriptor with the appropriate access, or add ACEs to the DACL that grants access to a group of users.
|
|
|
1865 </summary>
|
|
|
1866 </member>
|
|
|
1867 <member name="F:JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES.bInheritHandle">
|
|
|
1868 <summary>
|
|
|
1869 A Boolean value that specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.
|
|
|
1870 </summary>
|
|
|
1871 </member>
|
|
|
1872 <member name="F:JetBrains.Interop.WinApi.SERVICE_STATUS_PROCESS.dwServiceType">
|
|
|
1873 <summary>
|
|
|
1874 See <see cref="T:JetBrains.Interop.WinApi.ServiceType"/>
|
|
|
1875 </summary>
|
|
|
1876 </member>
|
|
|
1877 <member name="F:JetBrains.Interop.WinApi.SERVICE_STATUS_PROCESS.dwCurrentState">
|
|
|
1878 <summary>
|
|
|
1879 See <see cref="T:JetBrains.Interop.WinApi.ServiceState"/>
|
|
|
1880 </summary>
|
|
|
1881 </member>
|
|
|
1882 <member name="F:JetBrains.Interop.WinApi.SERVICE_STATUS_PROCESS.dwControlsAccepted">
|
|
|
1883 <summary>
|
|
|
1884 See <see cref="T:JetBrains.Interop.WinApi.ServiceAccept"/>
|
|
|
1885 </summary>
|
|
|
1886 </member>
|
|
|
1887 <member name="F:JetBrains.Interop.WinApi.SERVICE_STATUS_PROCESS.dwServiceFlags">
|
|
|
1888 <summary>
|
|
|
1889 See <see cref="T:JetBrains.Interop.WinApi.ServiceFlags"/>
|
|
|
1890 </summary>
|
|
|
1891 </member>
|
|
|
1892 <member name="T:JetBrains.Interop.WinApi.WinDef">
|
|
|
1893 <summary>
|
|
|
1894 Assorted constants.
|
|
|
1895 </summary>
|
|
|
1896 </member>
|
|
|
1897 <member name="F:JetBrains.Interop.WinApi.WinDef.CBM_INIT">
|
|
|
1898 <summary>
|
|
|
1899 /* constants for CreateDIBitmap */
|
|
|
1900 /* initialize bitmap */
|
|
|
1901 </summary>
|
|
|
1902 </member>
|
|
|
1903 <member name="F:JetBrains.Interop.WinApi.WinDef.DesktopDefault">
|
|
|
1904 <summary>
|
|
|
1905 The name of the input desktop in the interactive window station.
|
|
|
1906 </summary>
|
|
|
1907 </member>
|
|
|
1908 <member name="F:JetBrains.Interop.WinApi.WinDef.MAXIMUM_WAIT_OBJECTS">
|
|
|
1909 <summary>
|
|
|
1910 Maximum number of wait objects.
|
|
|
1911 </summary>
|
|
|
1912 </member>
|
|
|
1913 <member name="F:JetBrains.Interop.WinApi.WinDef.SizeOfVariant">
|
|
|
1914 <summary>
|
|
|
1915 Size of the <c>VARIANT</c> / <c>VARIANTARG</c> COM structures.
|
|
|
1916 </summary>
|
|
|
1917 </member>
|
|
|
1918 <member name="F:JetBrains.Interop.WinApi.WinDef.USER_TIMER_MAXIMUM">
|
|
|
1919 <summary>
|
|
|
1920 The SetTimer function creates a timer with the specified time-out value.
|
|
|
1921 uElapse
|
|
|
1922 [in] Specifies the time-out value, in milliseconds.
|
|
|
1923 Windows NT/2000/XP: If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to 1.
|
|
|
1924 Windows 2000/XP: If uElapse is less than USER_TIMER_MINIMUM, the timeout is set to USER_TIMER_MINIMUM.
|
|
|
1925 Windows Server 2003: If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to USER_TIMER_MAXIMUM.
|
|
|
1926 Windows XP SP2/Windows Server 2003 SP1: If uElapse is less than USER_TIMER_MINIMUM, the timeout is set to USER_TIMER_MINIMUM. If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to USER_TIMER_MAXIMUM.
|
|
|
1927 </summary>
|
|
|
1928 </member>
|
|
|
1929 <member name="F:JetBrains.Interop.WinApi.WinDef.USER_TIMER_MINIMUM">
|
|
|
1930 <summary>
|
|
|
1931 The SetTimer function creates a timer with the specified time-out value.
|
|
|
1932 uElapse
|
|
|
1933 [in] Specifies the time-out value, in milliseconds.
|
|
|
1934 Windows NT/2000/XP: If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to 1.
|
|
|
1935 Windows 2000/XP: If uElapse is less than USER_TIMER_MINIMUM, the timeout is set to USER_TIMER_MINIMUM.
|
|
|
1936 Windows Server 2003: If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to USER_TIMER_MAXIMUM.
|
|
|
1937 Windows XP SP2/Windows Server 2003 SP1: If uElapse is less than USER_TIMER_MINIMUM, the timeout is set to USER_TIMER_MINIMUM. If uElapse is greater than USER_TIMER_MAXIMUM, the timeout is set to USER_TIMER_MAXIMUM.
|
|
|
1938 </summary>
|
|
|
1939 </member>
|
|
|
1940 <member name="F:JetBrains.Interop.WinApi.WinDef.WinSta0">
|
|
|
1941 <summary>
|
|
|
1942 The interactive window station name, for use with <see cref="M:JetBrains.Interop.WinApi.User32Dll.OpenWindowStationW(System.String,System.Int32,System.UInt32)"/>.
|
|
|
1943 </summary>
|
|
|
1944 </member>
|
|
|
1945 <member name="T:JetBrains.Interop.WinApi.WinError">
|
|
|
1946 <summary>
|
|
|
1947 winerror.h -- error code definitions for the Win32 API functions.
|
|
|
1948 </summary>
|
|
|
1949 <remarks>
|
|
|
1950 <code>
|
|
|
1951 Values are 32 bit values laid out as follows:
|
|
|
1952
|
|
|
1953 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
|
|
|
1954 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
|
|
|
1955 +---+-+-+-----------------------+-------------------------------+
|
|
|
1956 |Sev|C|R| Facility | Code |
|
|
|
1957 +---+-+-+-----------------------+-------------------------------+
|
|
|
1958
|
|
|
1959 where
|
|
|
1960
|
|
|
1961 Sev - is the severity code
|
|
|
1962
|
|
|
1963 00 - Success
|
|
|
1964 01 - Informational
|
|
|
1965 10 - Warning
|
|
|
1966 11 - Error
|
|
|
1967
|
|
|
1968 C - is the Customer code flag
|
|
|
1969
|
|
|
1970 R - is a reserved bit
|
|
|
1971
|
|
|
1972 Facility - is the facility code
|
|
|
1973
|
|
|
1974 Code - is the facility's status code
|
|
|
1975 </code>
|
|
|
1976 </remarks>
|
|
|
1977 </member>
|
|
|
1978 <member name="T:JetBrains.Interop.WinApi.Gdi32Dll">
|
|
|
1979 <summary>
|
|
|
1980 User32.dll functions.
|
|
|
1981 Must be 64bit-safe.
|
|
|
1982 </summary>
|
|
|
1983 <remarks>
|
|
|
1984 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
1985 (1) All the function declarations MUST be 64-bit aware.
|
|
|
1986 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
1987 and you MUST ensure that each parameter has a proper size.
|
|
|
1988 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
1989 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
1990 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
1991 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
1992 but slows down the execution of critical members.
|
|
|
1993 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
1994 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
1995 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
1996 This greately improves the understanding of the parameter sizes.
|
|
|
1997 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
1998 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
1999 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
2000 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
2001 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
2002 (A) Same rules must apply to members of the structures.
|
|
|
2003 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
2004 </remarks>
|
|
|
2005 </member>
|
|
|
2006 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.BitBlt(System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,System.Void*,System.Int32,System.Int32,System.UInt32)">
|
|
|
2007 <summary>
|
|
|
2008 The BitBlt function performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context.
|
|
|
2009 </summary>
|
|
|
2010 <param name="hdcDest">handle to destination DC</param>
|
|
|
2011 <param name="nXDest">x-coord of destination upper-left corner</param>
|
|
|
2012 <param name="nYDest">y-coord of destination upper-left corner</param>
|
|
|
2013 <param name="nWidth">width of destination rectangle</param>
|
|
|
2014 <param name="nHeight">height of destination rectangle</param>
|
|
|
2015 <param name="hdcSrc">handle to source DC</param>
|
|
|
2016 <param name="nXSrc">x-coordinate of source upper-left corner</param>
|
|
|
2017 <param name="nYSrc">y-coordinate of source upper-left corner</param>
|
|
|
2018 <param name="dwRop">raster operation code. Use <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations"/>.</param>
|
|
|
2019 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.</returns>
|
|
|
2020 </member>
|
|
|
2021 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateCompatibleDC(System.Void*)">
|
|
|
2022 <summary>
|
|
|
2023 The CreateCompatibleDC function creates a memory device context (DC) compatible with the specified device.
|
|
|
2024 </summary>
|
|
|
2025 <param name="hdc">Handle to an existing DC. If this handle is NULL, the function creates a memory DC compatible with the application's current screen.</param>
|
|
|
2026 <returns>If the function succeeds, the return value is the handle to a memory DC. If the function fails, the return value is NULL.</returns>
|
|
|
2027 </member>
|
|
|
2028 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateDCW(System.String,System.String,System.String,System.Void*)">
|
|
|
2029 <summary>
|
|
|
2030 The CreateDC function creates a device context (DC) for a device using the specified name.
|
|
|
2031 </summary>
|
|
|
2032 <param name="lpszDriver">Windows 95/98/Me: The lpszDriver parameter can be NULL, WINSPL16 (a print provider), or (to obtain a display DC) it can be either the null-terminated string DISPLAY or the device name of a specific display device. If lpszDevice specifies a particular device, you must use NULL for lpszDriver.
|
|
|
2033 Windows NT 4.0: Pointer to a null-terminated character string that specifies either DISPLAY or the name of a print provider, which is usually WINSPOOL.
|
|
|
2034 Windows 2000/XP: Pointer to a null-terminated character string that specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. </param>
|
|
|
2035 <param name="lpszDevice">[in] Pointer to a null-terminated character string that specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). It is not the printer model name. The lpszDevice parameter must be used.
|
|
|
2036 To obtain valid names for displays, call EnumDisplayDevices.
|
|
|
2037 If lpszDriver is DISPLAY or the device name of a specific display device, then lpszDevice must be NULL or that same device name. If lpszDevice is NULL, then a DC is created for the primary display device.
|
|
|
2038 Windows NT 3.51 and Windows NT 4.0: There is only one (thus the primary) display device. Set lpszDevice to NULL.
|
|
|
2039 Windows 2000 and later: If there are multiple monitors on the system, calling CreateDC(TEXT("DISPLAY"),NULL,NULL,NULL) will create a DC covering all the monitors. </param>
|
|
|
2040 <param name="lpszOutput">This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows.</param>
|
|
|
2041 <param name="lpInitData">[in] Pointer to a DEVMODE structure containing device-specific initialization data for the device driver. The DocumentProperties function retrieves this structure filled in for a specified device. The lpInitData parameter must be NULL if the device driver is to use the default initialization (if any) specified by the user.
|
|
|
2042 If lpszDriver is DISPLAY, then lpInitData must be NULL. The display device's current DEVMODE is used</param>
|
|
|
2043 <returns>If the function succeeds, the return value is the handle to a DC for the specified device. If the function fails, the return value is NULL. The function will return NULL for a DEVMODE structure other than the current DEVMODE.</returns>
|
|
|
2044 </member>
|
|
|
2045 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.GetDeviceCaps(System.Void*,System.Int32)">
|
|
|
2046 <summary>
|
|
|
2047 The GetDeviceCaps function retrieves device-specific information for the specified device.
|
|
|
2048 </summary>
|
|
|
2049 <param name="hdc">A handle to the DC.</param>
|
|
|
2050 <param name="capindex">The item to be returned. See <seealso cref="T:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex"/> for possible values</param>
|
|
|
2051 <returns>The return value specifies the value of the desired item.</returns>
|
|
|
2052 </member>
|
|
|
2053 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateDIBSection(System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO*,System.UInt32,System.Void**,System.Void*,System.Int32)">
|
|
|
2054 <summary>
|
|
|
2055 The CreateDIBSection function creates a DIB that applications can write to directly. The function gives you a pointer to the location of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use to create the bitmap, or you can let the system allocate the memory for the bitmap.
|
|
|
2056 </summary>
|
|
|
2057 <param name="hdc">handle to DC</param>
|
|
|
2058 <param name="pbmi">bitmap data</param>
|
|
|
2059 <param name="iUsage">data type indicator. Use <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.DibColors"/>.</param>
|
|
|
2060 <param name="ppvBits">bit values</param>
|
|
|
2061 <param name="hSection">handle to file mapping object</param>
|
|
|
2062 <param name="dwOffset">offset to bitmap bit values</param>
|
|
|
2063 <returns>If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values.
|
|
|
2064 If the function fails, the return value is NULL, and *ppvBits is NULL. </returns>
|
|
|
2065 </member>
|
|
|
2066 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateDIBitmap(System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER*,System.UInt32,System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO*,System.UInt32)">
|
|
|
2067 <summary>
|
|
|
2068 The CreateDIBitmap function creates a compatible bitmap (DDB) from a DIB and, optionally, sets the bitmap bits.
|
|
|
2069 </summary>
|
|
|
2070 <param name="hdc">handle to DC</param>
|
|
|
2071 <param name="lpbmih">bitmap data</param>
|
|
|
2072 <param name="fdwInit">initialization option</param>
|
|
|
2073 <param name="lpbInit">initialization data</param>
|
|
|
2074 <param name="lpbmi">color-format data</param>
|
|
|
2075 <param name="fuUsage">color-data usage. Use <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.DibColors"/>.</param>
|
|
|
2076 <returns>If the function succeeds, the return value is a handle to the compatible bitmap.
|
|
|
2077 If the function fails, the return value is NULL.</returns>
|
|
|
2078 </member>
|
|
|
2079 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.CreatePen(System.Int32,System.Int32,System.UInt32)">
|
|
|
2080 <summary>
|
|
|
2081 The CreatePen function creates a logical pen that has the specified style, width, and color. The pen can subsequently be selected into a device context and used to draw lines and curves.
|
|
|
2082 </summary>
|
|
|
2083 </member>
|
|
|
2084 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.DeleteDC(System.Void*)">
|
|
|
2085 <summary>
|
|
|
2086 The DeleteDC function deletes the specified device context (DC).
|
|
|
2087 </summary>
|
|
|
2088 <param name="hDC">handle to DC</param>
|
|
|
2089 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.</returns>
|
|
|
2090 </member>
|
|
|
2091 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.DeleteObject(System.Void*)">
|
|
|
2092 <summary>
|
|
|
2093 The DeleteObject function deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid.
|
|
|
2094 </summary>
|
|
|
2095 <param name="hGDIObj">[in] Handle to a logical pen, brush, font, bitmap, region, or palette. </param>
|
|
|
2096 <returns>If the function succeeds, the return value is nonzero.
|
|
|
2097 If the specified handle is not valid or is currently selected into a DC, the return value is zero.
|
|
|
2098 Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
2099 <remarks>
|
|
|
2100 Do not delete a drawing object (pen or brush) while it is still selected into a DC.
|
|
|
2101 When a pattern brush is deleted, the bitmap associated with the brush is not deleted. The bitmap must be deleted independently.
|
|
|
2102 </remarks>
|
|
|
2103 </member>
|
|
|
2104 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.GdiFlush">
|
|
|
2105 <summary>
|
|
|
2106 The GdiFlush function flushes the calling thread's current batch.
|
|
|
2107 </summary>
|
|
|
2108 </member>
|
|
|
2109 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.GetStockObject(System.Int32)">
|
|
|
2110 <summary>
|
|
|
2111 The GetStockObject function retrieves a handle to one of the stock pens, brushes, fonts, or palettes.
|
|
|
2112 </summary>
|
|
|
2113 </member>
|
|
|
2114 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.SelectObject(System.Void*,System.Void*)">
|
|
|
2115 <summary>
|
|
|
2116 The SelectObject function selects an object into the specified device context (DC). The new object replaces the previous object of the same type.
|
|
|
2117 </summary>
|
|
|
2118 <param name="hDC">[in] Handle to the DC. </param>
|
|
|
2119 <param name="hGDIObj">[in] Handle to the object to be selected. The specified object must have been created by using one of the following functions.
|
|
|
2120 Object Functions
|
|
|
2121 Bitmap CreateBitmap, CreateBitmapIndirect, CreateCompatibleBitmap, CreateDIBitmap, CreateDIBSection (Bitmaps can be selected for memory DCs only, and for only one DC at a time.)
|
|
|
2122 Brush CreateBrushIndirect, CreateDIBPatternBrush, CreateDIBPatternBrushPt, CreateHatchBrush, CreatePatternBrush, CreateSolidBrush
|
|
|
2123 Font CreateFont, CreateFontIndirect
|
|
|
2124 Pen CreatePen, CreatePenIndirect
|
|
|
2125 Region CombineRgn, CreateEllipticRgn, CreateEllipticRgnIndirect, CreatePolygonRgn, CreateRectRgn, CreateRectRgnIndirect
|
|
|
2126 </param>
|
|
|
2127 <returns>
|
|
|
2128 If the selected object is not a region and the function succeeds, the return value is a handle to the object being replaced. If the selected object is a region and the function succeeds, the return value is one of the following values.
|
|
|
2129 Value Meaning
|
|
|
2130 SIMPLEREGION Region consists of a single rectangle.
|
|
|
2131 COMPLEXREGION Region consists of more than one rectangle.
|
|
|
2132 NULLREGION Region is empty.
|
|
|
2133 If an error occurs and the selected object is not a region, the return value is NULL. Otherwise, it is HGDI_ERROR.
|
|
|
2134 </returns>
|
|
|
2135 <remarks>
|
|
|
2136 This function returns the previously selected object of the specified type. An application should always replace a new object with the original, default object after it has finished drawing with the new object.
|
|
|
2137 An application cannot select a bitmap into more than one DC at a time.
|
|
|
2138 ICM: If the object being selected is a brush or a pen, color management is performed.
|
|
|
2139 </remarks>
|
|
|
2140 </member>
|
|
|
2141 <member name="M:JetBrains.Interop.WinApi.Gdi32Dll.StretchBlt(System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,System.UInt32)">
|
|
|
2142 <summary>
|
|
|
2143 The StretchBlt function copies a bitmap from a source rectangle into a destination rectangle, stretching or compressing the bitmap to fit the dimensions of the destination rectangle, if necessary. The system stretches or compresses the bitmap according to the stretching mode currently set in the destination device context.
|
|
|
2144 </summary>
|
|
|
2145 <param name="hdcDest">[in] Handle to the destination device context.</param>
|
|
|
2146 <param name="nXOriginDest">[in] Specifies the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. </param>
|
|
|
2147 <param name="nYOriginDest">[in] Specifies the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. </param>
|
|
|
2148 <param name="nWidthDest">[in] Specifies the width, in logical units, of the destination rectangle. </param>
|
|
|
2149 <param name="nHeightDest">[in] Specifies the height, in logical units, of the destination rectangle.</param>
|
|
|
2150 <param name="hdcSrc">[in] Handle to the source device context. </param>
|
|
|
2151 <param name="nXOriginSrc">[in] Specifies the x-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
|
|
|
2152 <param name="nYOriginSrc">[in] Specifies the y-coordinate, in logical units, of the upper-left corner of the source rectangle.</param>
|
|
|
2153 <param name="nWidthSrc">[in] Specifies the width, in logical units, of the source rectangle. </param>
|
|
|
2154 <param name="nHeightSrc">[in] Specifies the height, in logical units, of the source rectangle. </param>
|
|
|
2155 <param name="dwRop">[in] Specifies the raster operation to be performed. Raster operation codes define how the system combines colors in output operations that involve a brush, a source bitmap, and a destination bitmap. See BitBlt for a list of common raster operation codes (ROPs). Note that the CAPTUREBLT ROP generally cannot be used for printing device contexts. Use the <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations"/> enum.</param>
|
|
|
2156 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. Windows NT/2000/XP: To get extended error information, call GetLastError. </returns>
|
|
|
2157 </member>
|
|
|
2158 <member name="T:JetBrains.Interop.WinApi.HwndSpecial">
|
|
|
2159 <summary>
|
|
|
2160 Special HWND values.
|
|
|
2161 Cast to an <see cref="T:System.IntPtr"/> or a <see cref="T:System.Void"/>* when using.
|
|
|
2162 </summary>
|
|
|
2163 </member>
|
|
|
2164 <member name="T:JetBrains.Interop.WinApi.KeyStateMasks">
|
|
|
2165 <summary>
|
|
|
2166 Key State Masks for Mouse Messages.
|
|
|
2167 </summary>
|
|
|
2168 </member>
|
|
|
2169 <member name="T:JetBrains.Interop.WinApi.PenStyles">
|
|
|
2170 <summary>
|
|
|
2171 Pen Styles.
|
|
|
2172 </summary>
|
|
|
2173 </member>
|
|
|
2174 <member name="T:JetBrains.Interop.WinApi.PrintWindowFlags">
|
|
|
2175 <summary>
|
|
|
2176 Specifies the drawing options [for WM_PRINT]. You can combine one or more of the following flags.
|
|
|
2177 </summary>
|
|
|
2178 </member>
|
|
|
2179 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_CHECKVISIBLE">
|
|
|
2180 <summary>
|
|
|
2181 Draw the window only if it is visible.
|
|
|
2182 </summary>
|
|
|
2183 </member>
|
|
|
2184 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_NONCLIENT">
|
|
|
2185 <summary>
|
|
|
2186 Draw the non-client area of the window.
|
|
|
2187 </summary>
|
|
|
2188 </member>
|
|
|
2189 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_CLIENT">
|
|
|
2190 <summary>
|
|
|
2191 Draw the client area of the window.
|
|
|
2192 </summary>
|
|
|
2193 </member>
|
|
|
2194 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_ERASEBKGND">
|
|
|
2195 <summary>
|
|
|
2196 Erase the background before drawing the window.
|
|
|
2197 </summary>
|
|
|
2198 </member>
|
|
|
2199 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_CHILDREN">
|
|
|
2200 <summary>
|
|
|
2201 Draw all visible child windows.
|
|
|
2202 </summary>
|
|
|
2203 </member>
|
|
|
2204 <member name="F:JetBrains.Interop.WinApi.PrintWindowFlags.PRF_OWNED">
|
|
|
2205 <summary>
|
|
|
2206 Draw all owned windows.
|
|
|
2207 </summary>
|
|
|
2208 </member>
|
|
|
2209 <member name="T:JetBrains.Interop.WinApi.WmActivateCodes">
|
|
|
2210 <summary>
|
|
|
2211 WM_ACTIVATE wParam loword value.
|
|
|
2212 </summary>
|
|
|
2213 </member>
|
|
|
2214 <member name="F:JetBrains.Interop.WinApi.WmActivateCodes.Inactive">
|
|
|
2215 <summary>
|
|
|
2216 Deactivated.
|
|
|
2217 </summary>
|
|
|
2218 </member>
|
|
|
2219 <member name="F:JetBrains.Interop.WinApi.WmActivateCodes.Active">
|
|
|
2220 <summary>
|
|
|
2221 Activated by some method other than a mouse click (for example, by a call to the <see cref="M:JetBrains.Interop.WinApi.User32Dll.SetActiveWindow(System.Void*)"/> function or by use of the keyboard interface to select the window).
|
|
|
2222 </summary>
|
|
|
2223 </member>
|
|
|
2224 <member name="F:JetBrains.Interop.WinApi.WmActivateCodes.ClickActive">
|
|
|
2225 <summary>
|
|
|
2226 Activated by a mouse click.
|
|
|
2227 </summary>
|
|
|
2228 </member>
|
|
|
2229 <member name="T:JetBrains.Interop.WinApi.WmMouseActivateReturnCodes">
|
|
|
2230 <summary>
|
|
|
2231 <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_MOUSEACTIVATE"/> return codes.
|
|
|
2232 </summary>
|
|
|
2233 </member>
|
|
|
2234 <member name="T:JetBrains.Interop.WinApi.HResultHelpers">
|
|
|
2235 <summary>
|
|
|
2236 Helper methods related to the <c>HRESULT</c> type.
|
|
|
2237 </summary>
|
|
|
2238 </member>
|
|
|
2239 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(System.Int32,System.Int32[])">
|
|
|
2240 <summary>
|
|
|
2241 Checks the given <c>HRESULT</c>, if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>), and is not contained in <paramref name="expectedHRFailure"/>, then an exception-from-hresult is thrown.
|
|
|
2242 </summary>
|
|
|
2243 </member>
|
|
|
2244 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(System.Int32)">
|
|
|
2245 <summary>
|
|
|
2246 Checks the given <c>HRESULT</c>, and throws an exception if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>).
|
|
|
2247 </summary>
|
|
|
2248 </member>
|
|
|
2249 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(JetBrains.Interop.WinApi.HResults)">
|
|
|
2250 <summary>
|
|
|
2251 Checks the given <c>HRESULT</c>, and throws an exception if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>).
|
|
|
2252 </summary>
|
|
|
2253 </member>
|
|
|
2254 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(System.Int32,System.String)">
|
|
|
2255 <summary>
|
|
|
2256 Checks the given <c>HRESULT</c>, and throws an exception if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>).
|
|
|
2257 The comment is used in case of the failure only.
|
|
|
2258 </summary>
|
|
|
2259 </member>
|
|
|
2260 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(JetBrains.Interop.WinApi.HResults,System.String)">
|
|
|
2261 <summary>
|
|
|
2262 Checks the given <c>HRESULT</c>, and throws an exception if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>).
|
|
|
2263 The comment is used in case of the failure only.
|
|
|
2264 </summary>
|
|
|
2265 </member>
|
|
|
2266 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.Assert(JetBrains.Interop.WinApi.HResults,System.Action{System.Exception})">
|
|
|
2267 <summary>
|
|
|
2268 Checks the given <c>HRESULT</c>, and throws an exception if it's a failure one (<see cref="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)"/>).
|
|
|
2269 The FComment function is called in case of the failure only, should use <see cref="!:ExceptionEx.AddData"/> to contribute to the exception report.
|
|
|
2270 </summary>
|
|
|
2271 </member>
|
|
|
2272 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(JetBrains.Interop.WinApi.HResults)">
|
|
|
2273 <summary>
|
|
|
2274 The <c>FAILED</c> WinAPI Macro.
|
|
|
2275 </summary>
|
|
|
2276 </member>
|
|
|
2277 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.FAILED(System.Int32)">
|
|
|
2278 <summary>
|
|
|
2279 The <c>FAILED</c> WinAPI Macro.
|
|
|
2280 </summary>
|
|
|
2281 </member>
|
|
|
2282 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.SUCCEEDED(JetBrains.Interop.WinApi.HResults)">
|
|
|
2283 <summary>
|
|
|
2284 The <c>SUCCEEDED</c> WinAPI Macro.
|
|
|
2285 </summary>
|
|
|
2286 </member>
|
|
|
2287 <member name="M:JetBrains.Interop.WinApi.HResultHelpers.SUCCEEDED(System.Int32)">
|
|
|
2288 <summary>
|
|
|
2289 The <c>SUCCEEDED</c> WinAPI Macro.
|
|
|
2290 </summary>
|
|
|
2291 </member>
|
|
|
2292 <member name="T:JetBrains.Interop.WinApi.Kernel32Dll">
|
|
|
2293 <summary>
|
|
|
2294 Kernel32.dll functions.
|
|
|
2295 Must be 64bit-safe.
|
|
|
2296 </summary>
|
|
|
2297 <remarks>
|
|
|
2298 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
2299 (1) All the function declarations MUST be 64-bit aware.
|
|
|
2300 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
2301 and you MUST ensure that each parameter has a proper size.
|
|
|
2302 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
2303 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
2304 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
2305 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
2306 but slows down the execution of critical members.
|
|
|
2307 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
2308 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
2309 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
2310 This greately improves the understanding of the parameter sizes.
|
|
|
2311 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
2312 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
2313 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
2314 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
2315 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
2316 (A) Same rules must apply to members of the structures.
|
|
|
2317 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
2318 </remarks>
|
|
|
2319 </member>
|
|
|
2320 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CloseHandle(System.Void*)">
|
|
|
2321 <summary>
|
|
|
2322 Closes an open object handle.
|
|
|
2323 </summary>
|
|
|
2324 <param name="hObject">A valid handle to an open object.</param>
|
|
|
2325 <returns>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. If the application is running under a debugger, the function will throw an exception if it receives either a handle value that is not valid or a pseudo-handle value. This can happen if you close a handle twice, or if you call CloseHandle on a handle returned by the FindFirstFile function.</returns>
|
|
|
2326 </member>
|
|
|
2327 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.ConvertThreadToFiber(System.Void*)">
|
|
|
2328 <summary>
|
|
|
2329 Converts the current thread into a fiber. You must convert a thread into a fiber before you can schedule other fibers.
|
|
|
2330 </summary>
|
|
|
2331 <param name="lpParameter">A pointer to a variable that is passed to the fiber. The fiber can retrieve this data by using the GetFiberData macro.</param>
|
|
|
2332 <returns>If the function succeeds, the return value is the address of the fiber. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
2333 </member>
|
|
|
2334 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CreateFiber(System.IntPtr,System.Void*,System.Void*)">
|
|
|
2335 <summary>
|
|
|
2336 Allocates a fiber object, assigns it a stack, and sets up execution to begin at the specified start address, typically the fiber function. This function does not schedule the fiber. To specify both a commit and reserve stack size, use the CreateFiberEx function.
|
|
|
2337 </summary>
|
|
|
2338 <param name="dwStackSize">The initial size of the stack, in bytes. If this parameter is zero, the new fiber uses the default stack size for the executable. For more information, see Thread Stack Size.</param>
|
|
|
2339 <param name="lpStartAddress">A pointer to the application-defined function to be executed by the fiber and represents the starting address of the fiber. Execution of the newly created fiber does not begin until another fiber calls the SwitchToFiber function with this address. For more information of the fiber callback function, see FiberProc.</param>
|
|
|
2340 <param name="lpParameter">A pointer to a variable that is passed to the fiber. The fiber can retrieve this data by using the GetFiberData macro.</param>
|
|
|
2341 <returns>If the function succeeds, the return value is the address of the fiber. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
2342 </member>
|
|
|
2343 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CreateToolhelp32Snapshot(System.UInt32,System.UInt32)">
|
|
|
2344 <summary>
|
|
|
2345 Takes a snapshot of the specified processes, as well as the heaps, modules, and threads used by these processes.
|
|
|
2346 </summary>
|
|
|
2347 </member>
|
|
|
2348 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.DeleteFiber(System.Void*)">
|
|
|
2349 <summary>
|
|
|
2350 Deletes an existing fiber.
|
|
|
2351 </summary>
|
|
|
2352 <param name="lpFiber">The address of the fiber to be deleted.</param>
|
|
|
2353 </member>
|
|
|
2354 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.FindResourceW(System.Void*,System.String,System.String)">
|
|
|
2355 <summary>
|
|
|
2356 Determines the location of a resource with the specified type and name in the specified module. To specify a language, use the FindResourceEx function.
|
|
|
2357 </summary>
|
|
|
2358 </member>
|
|
|
2359 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetCurrentProcess">
|
|
|
2360 <summary>
|
|
|
2361 Retrieves a pseudo handle for the current process.
|
|
|
2362 </summary>
|
|
|
2363 <returns>The return value is a pseudo handle to the current process.</returns>
|
|
|
2364 </member>
|
|
|
2365 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetCurrentProcessId">
|
|
|
2366 <summary>
|
|
|
2367 Retrieves the process identifier of the calling process.
|
|
|
2368 </summary>
|
|
|
2369 <returns>The return value is the process identifier of the calling process.</returns>
|
|
|
2370 <remarks>Until the process terminates, the process identifier uniquely identifies the process throughout the system.</remarks>
|
|
|
2371 </member>
|
|
|
2372 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetCurrentThreadId">
|
|
|
2373 <summary>
|
|
|
2374 The GetCurrentThreadId function retrieves the thread identifier of the calling thread.
|
|
|
2375 Note: same as <see cref="M:System.AppDomain.GetCurrentThreadId"/>, but doesn't raise the “Obsolete” warning.
|
|
|
2376 </summary>
|
|
|
2377 </member>
|
|
|
2378 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetFileAttributesW(System.String)">
|
|
|
2379 <summary>
|
|
|
2380 Retrieves file system attributes for a specified file or directory.
|
|
|
2381 </summary>
|
|
|
2382 <param name="lpFileName">[in] The name of the file or directory.</param>
|
|
|
2383 <returns>If the function succeeds, the return value contains the attributes of the specified file or directory.
|
|
|
2384 If the function fails, the return value is INVALID_FILE_ATTRIBUTE.
|
|
|
2385 </returns>
|
|
|
2386 </member>
|
|
|
2387 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetFileAttributesExW(System.String,JetBrains.Interop.WinApi.Declarations.Constants.GET_FILEEX_INFO_LEVELS,JetBrains.Interop.WinApi.Declarations.Structures.WIN32_FILE_ATTRIBUTE_DATA@)">
|
|
|
2388 <summary>
|
|
|
2389 Retrieves attributes for a specified file or directory.
|
|
|
2390 </summary>
|
|
|
2391 <param name="lpFileName">The name of the file or directory.</param>
|
|
|
2392 <param name="fInfoLevelId">A class of attribute information to retrieve. This parameter can be the following value from the GET_FILEEX_INFO_LEVELS enumeration.</param>
|
|
|
2393 <param name="lpFileInformation">A pointer to a buffer that receives the attribute information. The type of attribute information that is stored into this buffer is determined by the value of <paramref name="fInfoLevelId"/></param>
|
|
|
2394 <returns>If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero (0). To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2395 </member>
|
|
|
2396 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetModuleFileNameW(System.Void*,System.Char*,System.UInt32)">
|
|
|
2397 <summary>
|
|
|
2398 Retrieves the fully-qualified path for the file that contains the specified module. The module must have been loaded by the current process.
|
|
|
2399 To locate the file for a module that was loaded by another process, use the GetModuleFileNameEx function.
|
|
|
2400 </summary>
|
|
|
2401 <param name="hModule">
|
|
|
2402 A handle to the loaded module whose path is being requested. If this parameter is NULL, GetModuleFileName retrieves the path of the executable file of the current process.
|
|
|
2403 The GetModuleFileName function does not retrieve the path for modules that were loaded using the LOAD_LIBRARY_AS_DATAFILE flag. For more information, see LoadLibraryEx.
|
|
|
2404 </param>
|
|
|
2405 <param name="lpFilename">
|
|
|
2406 A pointer to a buffer that receives the fully-qualified path of the module. If the length of the path is less than the size that the nSize parameter specifies, the function succeeds and the path is returned as a null-terminated string.
|
|
|
2407 If the length of the path exceeds the size that the nSize parameter specifies, the function succeeds and the string is truncated to nSize characters including the terminating null character.
|
|
|
2408 Windows XP/2000: The string is truncated to nSize characters and is not null terminated.
|
|
|
2409 The string returned will use the same format that was specified when the module was loaded. Therefore, the path can be a long or short file name, and can use the prefix "\\?\". For more information, see Naming a File.
|
|
|
2410 </param>
|
|
|
2411 <param name="nSize">The size of the lpFilename buffer, in TCHARs.</param>
|
|
|
2412 <returns>
|
|
|
2413 If the function succeeds, the return value is the length of the string that is copied to the buffer, in characters, not including the terminating null character. If the buffer is too small to hold the module name, the string is truncated to nSize characters including the terminating null character, the function returns nSize, and the function sets the last error to ERROR_INSUFFICIENT_BUFFER.
|
|
|
2414 Windows XP/2000: If the buffer is too small to hold the module name, the function returns nSize. The last error code remains ERROR_SUCCESS. If nSize is zero, the return value is zero and the last error code is ERROR_SUCCESS.
|
|
|
2415 If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError.
|
|
|
2416 </returns>
|
|
|
2417 </member>
|
|
|
2418 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetModuleHandleW(System.String)">
|
|
|
2419 <summary>
|
|
|
2420 Retrieves a module handle for the specified module. The module must have been loaded by the calling process.
|
|
|
2421 To avoid the race conditions described in the Remarks section, use the GetModuleHandleEx function.
|
|
|
2422 </summary>
|
|
|
2423 <param name="lpModuleName">The name of the loaded module (either a .dll or .exe file).
|
|
|
2424 If the file name extension is omitted, the default library extension .dll is appended.
|
|
|
2425 The file name string can include a trailing point character (.) to indicate that the module name has no extension.
|
|
|
2426 The string does not have to specify a path. When specifying a path, be sure to use backslashes (\), not forward slashes (/).
|
|
|
2427 The name is compared (case independently) to the names of modules currently mapped into the address space of the calling process.
|
|
|
2428 If this parameter is NULL, GetModuleHandle returns a handle to the file used to create the calling process (.exe file).
|
|
|
2429 The GetModuleHandle function does not retrieve handles for modules that were loaded using the LOAD_LIBRARY_AS_DATAFILE flag.
|
|
|
2430 For more information, see LoadLibraryEx.</param>
|
|
|
2431 <returns>If the function succeeds, the return value is a handle to the specified module.
|
|
|
2432 If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
2433 </member>
|
|
|
2434 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetPrivateProfileIntW(System.String,System.String,System.Int32,System.String)">
|
|
|
2435 <summary>
|
|
|
2436 Retrieves an integer associated with a key in the specified section of an initialization file. Note: This function is provided only for compatibility with 16-bit Windows-based applications. Applications should store initialization information in the registry.
|
|
|
2437 </summary>
|
|
|
2438 </member>
|
|
|
2439 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetPrivateProfileStringW(System.String,System.String,System.String,System.UInt16*,System.UInt32,System.String)">
|
|
|
2440 <summary>
|
|
|
2441 Retrieves a string from the specified section in an initialization file.
|
|
|
2442 Note: This function is provided only for compatibility with 16-bit Windows-based applications. Applications should store initialization information in the registry.
|
|
|
2443 </summary>
|
|
|
2444 </member>
|
|
|
2445 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetProcAddress(System.Void*,System.String)">
|
|
|
2446 <summary>
|
|
|
2447 Retrieves the address of an exported function or variable from the specified dynamic-link library (DLL).
|
|
|
2448 </summary>
|
|
|
2449 <param name="hModule">A handle to the DLL module that contains the function or variable. The LoadLibrary or GetModuleHandle function returns this handle.</param>
|
|
|
2450 <param name="lpProcName">The function or variable name, or the function's ordinal value. If this parameter is an ordinal value, it must be in the low-order word; the high-order word must be zero.</param>
|
|
|
2451 <returns>If the function succeeds, the return value is the address of the exported function or variable. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
2452 </member>
|
|
|
2453 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.LoadLibraryW(System.String)">
|
|
|
2454 <summary>
|
|
|
2455 The LoadLibrary function maps the specified executable module into the address space of the calling process.
|
|
|
2456 For additional load options, use the LoadLibraryEx function.
|
|
|
2457 </summary>
|
|
|
2458 <param name="lpFileName">[in] Pointer to a null-terminated string that names the executable module (either a .dll or .exe file). The name specified is the file name of the module and is not related to the name stored in the library module itself, as specified by the LIBRARY keyword in the module-definition (.def) file.
|
|
|
2459 If the string specifies a path but the file does not exist in the specified directory, the function fails. When specifying a path, be sure to use backslashes (\), not forward slashes (/).
|
|
|
2460 If the string does not specify a path, the function uses a standard search strategy to find the file. See the Remarks for more information.</param>
|
|
|
2461 <returns>If the function succeeds, the return value is a handle to the module.
|
|
|
2462 If the function fails, the return value is NULL. To get extended error information, call GetLastError.
|
|
|
2463 Windows Me/98/95: If you are using LoadLibrary to load a module that contains a resource whose numeric identifier is greater than 0x7FFF, LoadLibrary fails.
|
|
|
2464 If you are attempting to load a 16-bit DLL directly from 32-bit code, LoadLibrary fails. If you are attempting to load a DLL whose subsystem version is greater than 4.0, LoadLibrary fails. If your DllMain function tries to call the Unicode version of a function, LoadLibrary fails.</returns>
|
|
|
2465 </member>
|
|
|
2466 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.FreeLibrary(System.Void*)">
|
|
|
2467 <summary>
|
|
|
2468 Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count.
|
|
|
2469 When the reference count reaches zero, the module is unloaded from the address space of the calling process and the handle is no longer valid.
|
|
|
2470 </summary>
|
|
|
2471 <param name="hModule">[in] A handle to the loaded library module.
|
|
|
2472 The LoadLibrary, LoadLibraryEx, GetModuleHandle, or GetModuleHandleEx function returns this handle.</param>
|
|
|
2473 <returns>If the function succeeds, the return value is nonzero.
|
|
|
2474 If the function fails, the return value is zero. To get extended error information, call the GetLastError function.</returns>
|
|
|
2475 </member>
|
|
|
2476 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SetDllDirectory(System.String)">
|
|
|
2477 <summary>
|
|
|
2478 Adds a directory to the search path used to locate DLLs for the application.
|
|
|
2479 The <c>SetDllDirectory</c> function affects all subsequent calls to the <c>LoadLibrary</c> and <c>LoadLibraryEx</c> functions.
|
|
|
2480 It also effectively disables safe DLL search mode while the specified directory is in the search path.
|
|
|
2481 </summary>
|
|
|
2482 <param name="lpPathName">[in, optional] The directory to be added to the search path.
|
|
|
2483 If this parameter is an empty string (""), the call removes the current directory from the default DLL search order.
|
|
|
2484 If this parameter is NULL, the function restores the default search order.</param>
|
|
|
2485 <returns>If the function succeeds, the return value is nonzero.
|
|
|
2486 If the function fails, the return value is zero. To get extended error information, call GetLastError. </returns>
|
|
|
2487 </member>
|
|
|
2488 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.LoadResource(System.Void*,System.Void*)">
|
|
|
2489 <summary>
|
|
|
2490 Loads the specified resource into global memory.
|
|
|
2491 </summary>
|
|
|
2492 </member>
|
|
|
2493 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.LockResource(System.Void*)">
|
|
|
2494 <summary>
|
|
|
2495 Locks the specified resource in memory.
|
|
|
2496 </summary>
|
|
|
2497 </member>
|
|
|
2498 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.OutputDebugStringW(System.String)">
|
|
|
2499 <summary>
|
|
|
2500 The OutputDebugString function sends a string to the debugger for display.
|
|
|
2501 </summary>
|
|
|
2502 <param name="lpOutputString">[in] Pointer to the null-terminated string to be displayed.</param>
|
|
|
2503 </member>
|
|
|
2504 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Process32FirstW(System.Void*,System.Void*)">
|
|
|
2505 <summary>
|
|
|
2506 Retrieves information about the first process encountered in a system snapshot.
|
|
|
2507 </summary>
|
|
|
2508 </member>
|
|
|
2509 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.QueryPerformanceCounter(System.UInt64*)">
|
|
|
2510 <summary>
|
|
|
2511 The QueryPerformanceCounter function retrieves the current value of the high-resolution performance counter.
|
|
|
2512 </summary>
|
|
|
2513 <param name="lpPerformanceCount">[out] Pointer to a variable that receives the current performance-counter value, in counts.</param>
|
|
|
2514 <returns>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.</returns>
|
|
|
2515 <remarks>On a multiprocessor computer, it should not matter which processor is called. However, you can get different results on different processors due to bugs in the basic input/output system (BIOS) or the hardware abstraction layer (HAL). To specify processor affinity for a thread, use the SetThreadAffinityMask function. </remarks>
|
|
|
2516 </member>
|
|
|
2517 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.QueryPerformanceFrequency(System.UInt64*)">
|
|
|
2518 <summary>
|
|
|
2519 The QueryPerformanceFrequency function retrieves the frequency of the high-resolution performance counter, if one exists. The frequency cannot change while the system is running.
|
|
|
2520 </summary>
|
|
|
2521 <param name="lpFrequency">[out] Pointer to a variable that receives the current performance-counter frequency, in counts per second. If the installed hardware does not support a high-resolution performance counter, this parameter can be zero. </param>
|
|
|
2522 <returns>If the installed hardware supports a high-resolution performance counter, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError. For example, if the installed hardware does not support a high-resolution performance counter, the function fails. </returns>
|
|
|
2523 </member>
|
|
|
2524 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.RtlCopyMemory(System.Void*,System.Void*,System.UIntPtr)">
|
|
|
2525 <summary>
|
|
|
2526 The <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.RtlCopyMemory(System.Void*,System.Void*,System.UIntPtr)"/> routine copies the contents of one buffer to another.
|
|
|
2527 </summary>
|
|
|
2528 <param name="Destination">Pointer to the destination of the move.</param>
|
|
|
2529 <param name="Source">Pointer to the memory to be copied.</param>
|
|
|
2530 <param name="Length">Specifies the number of bytes to be copied.</param>
|
|
|
2531 </member>
|
|
|
2532 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.RtlMoveMemory(System.Void*,System.Void*,System.UIntPtr)">
|
|
|
2533 <summary>
|
|
|
2534 The <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.RtlMoveMemory(System.Void*,System.Void*,System.UIntPtr)"/> routine moves memory either forward or backward, aligned or unaligned, in 4-byte blocks, followed by any remaining bytes.
|
|
|
2535 </summary>
|
|
|
2536 <param name="Destination">Pointer to the destination of the move.</param>
|
|
|
2537 <param name="Source">Pointer to the memory to be copied.</param>
|
|
|
2538 <param name="Length">Specifies the number of bytes to be copied.</param>
|
|
|
2539 </member>
|
|
|
2540 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SizeofResource(System.Void*,System.Void*)">
|
|
|
2541 <summary>
|
|
|
2542 Returns the size, in bytes, of the specified resource.
|
|
|
2543 </summary>
|
|
|
2544 </member>
|
|
|
2545 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SwitchToFiber(System.Void*)">
|
|
|
2546 <summary>
|
|
|
2547 Schedules a fiber. The function must be called on a fiber.
|
|
|
2548 </summary>
|
|
|
2549 <param name="lpFiber">The address of the fiber to be scheduled.</param>
|
|
|
2550 </member>
|
|
|
2551 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.VirtualAlloc(System.Void*,System.IntPtr,System.UInt32,System.UInt32)">
|
|
|
2552 <summary>
|
|
|
2553 Reserves or commits a region of pages in the virtual address space of the calling process. Memory allocated by this function is automatically initialized to zero, unless MEM_RESET is specified.
|
|
|
2554 To allocate memory in the address space of another process, use the VirtualAllocEx function.
|
|
|
2555 </summary>
|
|
|
2556 <param name="lpAddress">The starting address of the region to allocate. If the memory is being reserved, the specified address is rounded down to the nearest multiple of the allocation granularity. If the memory is already reserved and is being committed, the address is rounded down to the next page boundary. To determine the size of a page and the allocation granularity on the host computer, use the GetSystemInfo function. If this parameter is NULL, the system determines where to allocate the region.</param>
|
|
|
2557 <param name="dwSize">The size of the region, in bytes. If the lpAddress parameter is NULL, this value is rounded up to the next page boundary. Otherwise, the allocated pages include all pages containing one or more bytes in the range from lpAddress to lpAddress+dwSize. This means that a 2-byte range straddling a page boundary causes both pages to be included in the allocated region.</param>
|
|
|
2558 <param name="flAllocationType">The type of memory allocation. See <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryAllocationTypes"/>.</param>
|
|
|
2559 <param name="flProtect">The memory protection for the region of pages to be allocated. If the pages are being committed, you can specify any one of the <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants">memory protection constants</see>.</param>
|
|
|
2560 <returns>If the function succeeds, the return value is the base address of the allocated region of pages.
|
|
|
2561 If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
2562 </member>
|
|
|
2563 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.VirtualProtect(System.Void*,System.IntPtr,System.UInt32,System.UInt32*)">
|
|
|
2564 <summary>
|
|
|
2565 Changes the protection on a region of committed pages in the virtual address space of the calling process.
|
|
|
2566 To change the access protection of any process, use the VirtualProtectEx function.
|
|
|
2567 </summary>
|
|
|
2568 <param name="lpAddress">A pointer to the base address of the region of pages whose access protection attributes are to be changed.
|
|
|
2569 All pages in the specified region must be within the same reserved region allocated when calling the VirtualAlloc or VirtualAllocEx function using MEM_RESERVE. The pages cannot span adjacent reserved regions that were allocated by separate calls to VirtualAlloc or VirtualAllocEx using MEM_RESERVE.The size of the region whose access protection attributes are to be changed, in bytes. The region of affected pages includes all pages containing one or more bytes in the range from the lpAddress parameter to (lpAddress+dwSize). This means that a 2-byte range straddling a page boundary causes the protection attributes of both pages to be changed.</param>
|
|
|
2570 <param name="dwSize">The size of the region whose access protection attributes are to be changed, in bytes. The region of affected pages includes all pages containing one or more bytes in the range from the lpAddress parameter to (lpAddress+dwSize). This means that a 2-byte range straddling a page boundary causes the protection attributes of both pages to be changed.</param>
|
|
|
2571 <param name="flNewProtect">The memory protection option. This parameter can be one of the <see cref="T:JetBrains.Interop.WinApi.Declarations.Constants.MemoryProtectionConstants">memory protection constants</see>.
|
|
|
2572 This value must be compatible with the access protection specified for the pages using VirtualAlloc or VirtualAllocEx.</param>
|
|
|
2573 <param name="lpflOldProtect">A pointer to a variable that receives the previous access protection value of the first page in the specified region of pages. If this parameter is NULL or does not point to a valid variable, the function fails.</param>
|
|
|
2574 <returns>If the function succeeds, the return value is nonzero.
|
|
|
2575 If the function fails, the return value is zero. To get extended error information, call GetLastError.</returns>
|
|
|
2576 </member>
|
|
|
2577 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.VirtualQuery(System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION*,System.IntPtr)">
|
|
|
2578 <summary>
|
|
|
2579 Retrieves information about a range of pages in the virtual address space of the calling process.
|
|
|
2580 To retrieve information about a range of pages in the address space of another process, use the VirtualQueryEx function.
|
|
|
2581 </summary>
|
|
|
2582 <param name="lpAddress">A pointer to the base address of the region of pages to be queried. This value is rounded down to the next page boundary. To determine the size of a page on the host computer, use the GetSystemInfo function.
|
|
|
2583 If lpAddress specifies an address above the highest memory address accessible to the process, the function fails with ERROR_INVALID_PARAMETER.
|
|
|
2584 </param>
|
|
|
2585 <param name="lpBuffer">A pointer to a <see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.MEMORY_BASIC_INFORMATION"/> structure in which information about the specified page range is returned.</param>
|
|
|
2586 <param name="dwLength">The size of the buffer pointed to by the lpBuffer parameter, in bytes.</param>
|
|
|
2587 <returns>The return value is the actual number of bytes returned in the information buffer.
|
|
|
2588 If the function fails, the return value is zero. To get extended error information, call GetLastError. Possible error values include ERROR_INVALID_PARAMETER.
|
|
|
2589 </returns>
|
|
|
2590 </member>
|
|
|
2591 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.WaitForMultipleObjects(System.UInt32,System.Void**,System.Int32,System.UInt32)">
|
|
|
2592 <summary>
|
|
|
2593 Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses. To enter an alertable wait state, use the WaitForMultipleObjectsEx function.
|
|
|
2594 </summary>
|
|
|
2595 </member>
|
|
|
2596 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.WaitForSingleObject(System.Void*,System.UInt32)">
|
|
|
2597 <summary>
|
|
|
2598 Waits until the specified object is in the signaled state or the time-out interval elapses. To enter an alertable wait state, use the WaitForSingleObjectEx function. To wait for multiple objects, use the WaitForMultipleObjects.
|
|
|
2599 </summary>
|
|
|
2600 </member>
|
|
|
2601 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.WritePrivateProfileStringW(System.String,System.String,System.String,System.String)">
|
|
|
2602 <summary>
|
|
|
2603 Copies a string into the specified section of an initialization file.
|
|
|
2604 Note This function is provided only for compatibility with 16-bit versions of Windows. Applications should store initialization information in the registry.
|
|
|
2605 </summary>
|
|
|
2606 <param name="lpAppName">The name of the section to which the string will be copied. If the section does not exist, it is created. The name of the section is case-independent; the string can be any combination of uppercase and lowercase letters.</param>
|
|
|
2607 <param name="lpKeyName">The name of the key to be associated with a string. If the key does not exist in the specified section, it is created. If this parameter is NULL, the entire section, including all entries within the section, is deleted.</param>
|
|
|
2608 <param name="lpString">A null-terminated string to be written to the file. If this parameter is NULL, the key pointed to by the lpKeyName parameter is deleted.
|
|
|
2609 Windows Me/98/95: The system does not support the use of the TAB (\t) character as part of this parameter.</param>
|
|
|
2610 <param name="lpFileName">The name of the initialization file.
|
|
|
2611 If the file was created using Unicode characters, the function writes Unicode characters to the file. Otherwise, the function writes ANSI characters.</param>
|
|
|
2612 <returns>If the function successfully copies the string to the initialization file, the return value is nonzero. If the function fails, or if it flushes the cached version of the most recently accessed initialization file, the return value is zero. To get extended error information, call GetLastError.</returns>
|
|
|
2613 </member>
|
|
|
2614 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CreateFileW(System.String,JetBrains.Interop.WinApi.AccessRights,JetBrains.Interop.WinApi.Declarations.Constants.FileShareFlags,JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES*,JetBrains.Interop.WinApi.Declarations.Constants.CreationDisposition,JetBrains.Interop.WinApi.Declarations.Constants.FileFlagsAndAttributes,System.IntPtr)">
|
|
|
2615 <summary>
|
|
|
2616 The CreateFile function creates or opens a file, file stream, directory, physical disk, volume, console buffer, tape drive,
|
|
|
2617 communications resource, mailslot, or named pipe. The function returns a handle that can be used to access an object.
|
|
|
2618 </summary>
|
|
|
2619 <param name="lpFileName"></param>
|
|
|
2620 <param name="dwDesiredAccess"> access to the object, which can be read, write, or both</param>
|
|
|
2621 <param name="dwShareMode">The sharing mode of an object, which can be read, write, both, or none</param>
|
|
|
2622 <param name="securityAttributes">A pointer to a SECURITY_ATTRIBUTES structure that determines whether or not the returned handle can
|
|
|
2623 be inherited by child processes. Can be null</param>
|
|
|
2624 <param name="dwCreationDisposition">An action to take on files that exist and do not exist</param>
|
|
|
2625 <param name="dwFlagsAndAttributes">The file attributes and flags. </param>
|
|
|
2626 <param name="hTemplateFile">A handle to a template file with the GENERIC_READ access right. The template file supplies file attributes
|
|
|
2627 and extended attributes for the file that is being created. This parameter can be null</param>
|
|
|
2628 <returns>If the function succeeds, the return value is an open handle to a specified file. If a specified file exists before the function
|
|
|
2629 all and dwCreationDisposition is CREATE_ALWAYS or OPEN_ALWAYS, a call to GetLastError returns ERROR_ALREADY_EXISTS, even when the function
|
|
|
2630 succeeds. If a file does not exist before the call, GetLastError returns 0 (zero).
|
|
|
2631 If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error information, call GetLastError.
|
|
|
2632 </returns>
|
|
|
2633 </member>
|
|
|
2634 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.ReadDirectoryChangesW(Microsoft.Win32.SafeHandles.SafeFileHandle,System.Runtime.InteropServices.HandleRef,System.UInt32,System.Boolean,System.IO.NotifyFilters,System.UInt32@,System.Threading.NativeOverlapped*,System.Runtime.InteropServices.HandleRef)">
|
|
|
2635 <summary>
|
|
|
2636 Retrieves information that describes the changes within the specified directory. The function does not report changes to the specified directory itself.
|
|
|
2637 </summary>
|
|
|
2638 <param name="hDirectory">A handle to the directory to be monitored. This directory must be opened with the FILE_LIST_DIRECTORY access right.</param>
|
|
|
2639 <param name="lpBuffer">A pointer to the DWORD-aligned formatted buffer in which the read results are to be returned. The structure of this buffer is defined by the FILE_NOTIFY_INFORMATION structure. This buffer is filled either synchronously or asynchronously, depending on how the directory is opened and what value is given to the lpOverlapped parameter.</param>
|
|
|
2640 <param name="nBufferLength">The size of the buffer that is pointed to by the lpBuffer parameter, in bytes.</param>
|
|
|
2641 <param name="bWatchSubtree">If this parameter is TRUE, the function monitors the directory tree rooted at the specified directory. If this parameter is FALSE, the function monitors only the directory specified by the hDirectory parameter.</param>
|
|
|
2642 <param name="dwNotifyFilter">The filter criteria that the function checks to determine if the wait operation has completed.</param>
|
|
|
2643 <param name="lpBytesReturned">For synchronous calls, this parameter receives the number of bytes transferred into the lpBuffer parameter. For asynchronous calls, this parameter is undefined. You must use an asynchronous notification technique to retrieve the number of bytes transferred.</param>
|
|
|
2644 <param name="overlappedPointer">A pointer to an OVERLAPPED structure that supplies data to be used during asynchronous operation. Otherwise, this value is NULL. The Offset and OffsetHigh members of this structure are not used.</param>
|
|
|
2645 <param name="lpCompletionRoutine">A pointer to a completion routine to be called when the operation has been completed or canceled and the calling thread is in an alertable wait state.</param>
|
|
|
2646 <returns>If the function succeeds, the return value is nonzero. For synchronous calls, this means that the operation succeeded. For asynchronous calls, this indicates that the operation was successfully queued. If the function fails, the return value is zero. To get extended error information, call GetLastError. If the network redirector or the target file system does not support this operation, the function fails with ERROR_INVALID_FUNCTION.</returns>
|
|
|
2647 </member>
|
|
|
2648 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetFileSizeEx(System.IntPtr,System.Int64@)">
|
|
|
2649 <summary>
|
|
|
2650 Retrieves the size of the specified file.
|
|
|
2651 </summary>
|
|
|
2652 </member>
|
|
|
2653 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SetFileAttributesW(System.String,System.UInt32)">
|
|
|
2654 <summary>
|
|
|
2655 Sets the attributes for a file or directory.
|
|
|
2656 </summary>
|
|
|
2657 <param name="lpFileName">The name of the file whose attributes are to be set</param>
|
|
|
2658 <param name="dwFileAttributes">The file attributes to set for the file. This parameter can be one or more values, combined using the bitwise-OR operator. However, all other values override FILE_ATTRIBUTE_NORMAL</param>
|
|
|
2659 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2660 </member>
|
|
|
2661 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CopyFileW(System.String,System.String,System.Boolean)">
|
|
|
2662 <summary>
|
|
|
2663 Copies an existing file to a new file.
|
|
|
2664 </summary>
|
|
|
2665 <remarks>
|
|
|
2666 Security attributes for the existing file are copied to the new file. File attributes for the existing file are copied to the new file. For example, if an existing file has the FILE_ATTRIBUTE_READONLY file attribute, a copy created through a call to CopyFile will also have the FILE_ATTRIBUTE_READONLY file attribute. When CopyFile is used to copy an encrypted file, it attempts to encrypt the destination file with the keys used in the encryption of the source file. If this cannot be done, this function attempts to encrypt the destination file with default keys. If neither of these methods can be done, CopyFile fails with an ERROR_ENCRYPTION_FAILED error code. Symbolic link behavior—If the source file is a symbolic link, the actual file copied is the target of the symbolic link. If the destination file already exists and is a symbolic link, the target of the symbolic link is overwritten by the source file.
|
|
|
2667 </remarks>
|
|
|
2668 <param name="lpExistingFileName">The name of an existing file. If lpExistingFileName does not exist, CopyFile fails, and GetLastError returns ERROR_FILE_NOT_FOUND.</param>
|
|
|
2669 <param name="lpNewFileName">The name of the new file.</param>
|
|
|
2670 <param name="bFailIfExists">If this parameter is TRUE and the new file specified by lpNewFileName already exists, the function fails. If this parameter is FALSE and the new file already exists, the function overwrites the existing file and succeeds.</param>
|
|
|
2671 <returns>If the function succeeds, the return value is nonzero.</returns>
|
|
|
2672 </member>
|
|
|
2673 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.MoveFileW(System.String,System.String)">
|
|
|
2674 <summary>
|
|
|
2675 Moves an existing file or a directory, including its children.
|
|
|
2676 </summary>
|
|
|
2677 <param name="lpExistingFileName">The current name of the file or directory on the local computer.</param>
|
|
|
2678 <param name="lpNewFileName">The new name for the file or directory. The new name must not already exist. A new file may be on a different file system or drive. A new directory must be on the same drive.</param>
|
|
|
2679 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2680 </member>
|
|
|
2681 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.DeleteFileW(System.String)">
|
|
|
2682 <summary>
|
|
|
2683 Deletes an existing file.
|
|
|
2684 </summary>
|
|
|
2685 <param name="lpFileName">The name of the file to be deleted.</param>
|
|
|
2686 <returns>If the function fails, the return value is zero (0). To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2687 <remarks>See MSDN page for behaviour explanation</remarks>
|
|
|
2688 </member>
|
|
|
2689 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetLongPathName(System.String,System.Text.StringBuilder,System.UInt32)">
|
|
|
2690 <summary>
|
|
|
2691 Converts the specified path to its long form.
|
|
|
2692 </summary>
|
|
|
2693 <param name="lpszShortPath">The path to be converted.</param>
|
|
|
2694 <param name="lpszLongPath">A pointer to the buffer to receive the long path. You can use the same buffer you used for the lpszShortPath parameter.</param>
|
|
|
2695 <param name="cchBuffer">The size of the buffer lpszLongPath points to, in TCHARs.</param>
|
|
|
2696 <returns>If the function succeeds, the return value is the length, in TCHARs, of the string copied to lpszLongPath, not including the terminating null character. If the lpBuffer buffer is too small to contain the path, the return value is the size, in TCHARs, of the buffer that is required to hold the path and the terminating null character. If the function fails for any other reason, such as if the file does not exist, the return value is zero. To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2697 </member>
|
|
|
2698 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.GetShortPathName(System.String,System.Text.StringBuilder,System.UInt32)">
|
|
|
2699 <summary>
|
|
|
2700 Retrieves the short path form of the specified path.
|
|
|
2701 </summary>
|
|
|
2702 <param name="lpszLongPath">The path string.</param>
|
|
|
2703 <param name="lpszShortPath">A pointer to a buffer to receive the null-terminated short form of the path that lpszLongPath specifies. Passing NULL for this parameter and zero for cchBuffer will always return the required buffer size for a specified lpszLongPath.</param>
|
|
|
2704 <param name="cchBuffer">The size of the buffer that lpszShortPath points to, in TCHARs. Set this parameter to zero if lpszShortPath is set to NULL.</param>
|
|
|
2705 <returns>If the function succeeds, the return value is the length, in TCHARs, of the string that is copied to lpszShortPath, not including the terminating null character. If the lpszShortPath buffer is too small to contain the path, the return value is the size of the buffer, in TCHARs, that is required to hold the path and the terminating null character. If the function fails for any other reason, the return value is zero. To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2706 </member>
|
|
|
2707 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.RemoveDirectoryW(System.String)">
|
|
|
2708 <summary>
|
|
|
2709 Deletes an existing empty directory.
|
|
|
2710 </summary>
|
|
|
2711 <param name="lpPathName">The path of the directory to be removed. This path must specify an empty directory, and the calling process must have delete access to the directory.</param>
|
|
|
2712 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</returns>
|
|
|
2713 <remarks>The RemoveDirectory function marks a directory for deletion on close. Therefore, the directory is not removed until the last handle to the directory is closed. RemoveDirectory removes a directory junction, even if the contents of the target are not empty; the function removes directory junctions regardless of the state of the target object.</remarks>
|
|
|
2714 </member>
|
|
|
2715 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SetFileTime(Microsoft.Win32.SafeHandles.SafeFileHandle,JetBrains.Interop.WinApi.Declarations.Structures.FILE_TIME*,JetBrains.Interop.WinApi.Declarations.Structures.FILE_TIME*,JetBrains.Interop.WinApi.Declarations.Structures.FILE_TIME*)">
|
|
|
2716 <summary>
|
|
|
2717 Sets the date and time that the specified file or directory was created, last accessed, or last modified.
|
|
|
2718 </summary>
|
|
|
2719 <param name="hFile">A handle to the file or directory. The handle must have been created using the CreateFile function with the FILE_WRITE_ATTRIBUTES access right.</param>
|
|
|
2720 <param name="lpCreationTime">A pointer to a FILETIME structure that contains the new creation date and time for the file or directory. This parameter can be NULL if the application does not need to change this information.</param>
|
|
|
2721 <param name="lpLastAccessTime">A pointer to a FILETIME structure that contains the new last access date and time for the file or directory. The last access time includes the last time the file or directory was written to, read from, or (in the case of executable files) run. This parameter can be NULL if the application does not need to change this information. To prevent file operations using the given handle from modifying the last access time, call SetFileTime immediately after opening the file handle and pass a FILETIME structure whose dwLowDateTime and dwHighDateTime members are both set to 0xFFFFFFFF.</param>
|
|
|
2722 <param name="lpLastWriteTime">A pointer to a FILETIME structure that contains the new last modified date and time for the file or directory. This parameter can be NULL if the application does not need to change this information. To prevent file operations using the given handle from modifying the last access time, call SetFileTime immediately after opening the file handle and pass a FILETIME structure whose dwLowDateTime and dwHighDateTime members are both set to 0xFFFFFFFF.</param>
|
|
|
2723 <returns>If the function succeeds, the return value is nonzero.</returns>
|
|
|
2724 </member>
|
|
|
2725 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.SetErrorMode(JetBrains.Interop.WinApi.Declarations.Constants.Win32ErrorMode)">
|
|
|
2726 <summary>
|
|
|
2727 Controls whether the system will handle the specified types of serious errors or whether the process will handle them.
|
|
|
2728 </summary>
|
|
|
2729 <param name="uMode">The process error mode</param>
|
|
|
2730 <returns>The return value is the previous state of the error-mode bit flags.</returns>
|
|
|
2731 <remarks>Each process has an associated error mode that indicates to the system how the application is going to respond to serious errors. A child process inherits the error mode of its parent process. To retrieve the process error mode, use the GetErrorMode function. Because the error mode is set for the entire process, you must ensure that multi-threaded applications do not set different error-mode flags. Doing so can lead to inconsistent error handling. The system does not make alignment faults visible to an application on all processor architectures. Therefore, specifying SEM_NOALIGNMENTFAULTEXCEPT is not an error on such architectures, but the system is free to silently ignore the request.</remarks>
|
|
|
2732 </member>
|
|
|
2733 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.IsWow64Process(System.Void*,System.Boolean@)">
|
|
|
2734 <summary>
|
|
|
2735 Determines whether the specified process is running under WOW64.
|
|
|
2736 </summary>
|
|
|
2737 <param name="hProcess">Process handle</param>
|
|
|
2738 <param name="wow64Process">A pointer to a value that is set to TRUE if the process is running under WOW64. If the process is running under 32-bit Windows, the value is set to FALSE. If the process is a 64-bit application running under 64-bit Windows, the value is also set to FALSE.</param>
|
|
|
2739 <returns></returns>
|
|
|
2740 </member>
|
|
|
2741 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.CreateFileMappingW(System.Void*,JetBrains.Interop.WinApi.SECURITY_ATTRIBUTES*,System.UInt32,System.UInt32,System.UInt32,System.String)">
|
|
|
2742 <summary>
|
|
|
2743 Creates or opens a named or unnamed file mapping object for a specified file.
|
|
|
2744 </summary>
|
|
|
2745 </member>
|
|
|
2746 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.MapViewOfFile(System.Void*,System.UInt32,System.UInt32,System.UInt32,System.UIntPtr)">
|
|
|
2747 <summary>
|
|
|
2748 Maps a view of a file mapping into the address space of a calling process.
|
|
|
2749 </summary>
|
|
|
2750 </member>
|
|
|
2751 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.UnmapViewOfFile(System.Void*)">
|
|
|
2752 <summary>
|
|
|
2753 Unmaps a mapped view of a file from the calling process's address space.
|
|
|
2754 </summary>
|
|
|
2755 <param name="lpBaseAddress">A pointer to the base address of the mapped view of a file that is to be unmapped. This value must be identical to the value returned by a previous call to the MapViewOfFile or MapViewOfFileEx function.</param>
|
|
|
2756 <returns>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.</returns>
|
|
|
2757 </member>
|
|
|
2758 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.MoveFileExW(System.String,System.String,System.UInt32)">
|
|
|
2759 <summary>
|
|
|
2760 Moves an existing file or directory, including its children, with various move options.
|
|
|
2761 The MoveFileWithProgress function is equivalent to the MoveFileEx function, except that MoveFileWithProgress allows you to provide a callback function that receives progress notifications.
|
|
|
2762 To perform this operation as a transacted operation, use the MoveFileTransacted function.
|
|
|
2763 </summary>
|
|
|
2764 </member>
|
|
|
2765 <member name="T:JetBrains.Interop.WinApi.Kernel32Dll.Helpers">
|
|
|
2766 <summary>
|
|
|
2767 Wrappers for the functions in this DLL.
|
|
|
2768 </summary>
|
|
|
2769 </member>
|
|
|
2770 <member name="F:JetBrains.Interop.WinApi.Kernel32Dll.Helpers._performancefrequency">
|
|
|
2771 <summary>
|
|
|
2772 Frequency of the performance counter, for <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.GetHighPrecisionSystemTime"/>.
|
|
|
2773 </summary>
|
|
|
2774 </member>
|
|
|
2775 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.CoCreateInstanceExplicit(System.String,System.Guid)">
|
|
|
2776 <summary>
|
|
|
2777 Creates an instance of a COM object without the Registry information, by loading the DLL and invoking its class factory.
|
|
|
2778 </summary>
|
|
|
2779 <param name="sDllFilename">Pathname of the DLL.</param>
|
|
|
2780 <param name="guidClsid">CLSID of the object to create.</param>
|
|
|
2781 </member>
|
|
|
2782 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.GetHighPrecisionSystemTime">
|
|
|
2783 <summary>
|
|
|
2784 Gets the high-precision system time value, in milliseconds.
|
|
|
2785 Throws if not supported on the system (unlikely).
|
|
|
2786 May yield irrelevant data on non-synchronized CPU cores.
|
|
|
2787 </summary>
|
|
|
2788 </member>
|
|
|
2789 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.GetProfileString(System.String,System.String,System.String,System.String)">
|
|
|
2790 <summary>
|
|
|
2791 Reads an .ini string.
|
|
|
2792 </summary>
|
|
|
2793 </member>
|
|
|
2794 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.GetWin32Resource(System.String,System.String,System.String)">
|
|
|
2795 <summary>
|
|
|
2796 Loads a native dll and looks up the resource.
|
|
|
2797 Throws on errors.
|
|
|
2798 </summary>
|
|
|
2799 </member>
|
|
|
2800 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.IsWow64Process">
|
|
|
2801 <summary>
|
|
|
2802 Calls the <c>IsWow64Process</c> API function, if one is present on this OS version.
|
|
|
2803 </summary>
|
|
|
2804 </member>
|
|
|
2805 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.IsWow64Process(System.Void*)">
|
|
|
2806 <summary>
|
|
|
2807 Calls the <c>IsWow64Process</c> API function, if one is present on this OS version.
|
|
|
2808 </summary>
|
|
|
2809 </member>
|
|
|
2810 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.WaitForSingleObject(System.IntPtr,System.TimeSpan)">
|
|
|
2811 <summary>
|
|
|
2812 Waits for the object, returns whether the wait was successful.
|
|
|
2813 The abandoned state is considered success.
|
|
|
2814 </summary>
|
|
|
2815 <param name="handle">Handle to wait for.</param>
|
|
|
2816 <param name="timeout">Timeout. <see cref="F:System.TimeSpan.Zero"/> to test without waiting, <see cref="F:System.TimeSpan.MaxValue"/> to wait infinitely.</param>
|
|
|
2817 <returns>Whether the wait has succeeded.</returns>
|
|
|
2818 </member>
|
|
|
2819 <member name="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.GetModulePath(System.Void*)">
|
|
|
2820 <summary>
|
|
|
2821 Retrieves the fully qualified path for the file that contains the specified module. The module must have been loaded by the current process.
|
|
|
2822 Wraps WinAPI function <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.GetModuleFileNameW(System.Void*,System.Char*,System.UInt32)"/>.
|
|
|
2823 </summary>
|
|
|
2824 <param name="hModule">A handle to the loaded module whose path is being requested.
|
|
|
2825 If this parameter is NULL, GetModuleFileName retrieves the path of the executable file of the current process.</param>
|
|
|
2826 <returns>The fully qualified path of the module.</returns>
|
|
|
2827 </member>
|
|
|
2828 <member name="T:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.DllGetClassObjectDelegate">
|
|
|
2829 <summary>
|
|
|
2830 Helper for the <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.CoCreateInstanceExplicit(System.String,System.Guid)"/> function.
|
|
|
2831 </summary>
|
|
|
2832 </member>
|
|
|
2833 <member name="T:JetBrains.Interop.WinApi.Kernel32Dll.Helpers.IsWow64ProcessDelegate">
|
|
|
2834 <summary>
|
|
|
2835 Delegate to Kernel32 <c>IsWow64Process</c> API func.
|
|
|
2836 </summary>
|
|
|
2837 </member>
|
|
|
2838 <member name="T:JetBrains.Interop.WinApi.WindowClassStyles">
|
|
|
2839 <summary>
|
|
|
2840 “<c>CS_…</c>” window class styles from the <c>RegisterClassEx</c> function.
|
|
|
2841 </summary>
|
|
|
2842 </member>
|
|
|
2843 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_BYTEALIGNCLIENT">
|
|
|
2844 <summary>
|
|
|
2845 Aligns the window's client area on a byte boundary (in the x direction). This style affects the width of the window and its horizontal placement on the display.
|
|
|
2846 </summary>
|
|
|
2847 </member>
|
|
|
2848 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_BYTEALIGNWINDOW">
|
|
|
2849 <summary>
|
|
|
2850 Aligns the window on a byte boundary (in the x direction). This style affects the width of the window and its horizontal placement on the display.
|
|
|
2851 </summary>
|
|
|
2852 </member>
|
|
|
2853 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_CLASSDC">
|
|
|
2854 <summary>
|
|
|
2855 Allocates one device context to be shared by all windows in the class. Because window classes are process specific, it is possible for multiple threads of an application to create a window of the same class. It is also possible for the threads to attempt to use the device context simultaneously. When this happens, the system allows only one thread to successfully finish its drawing operation.
|
|
|
2856 </summary>
|
|
|
2857 </member>
|
|
|
2858 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_DBLCLKS">
|
|
|
2859 <summary>
|
|
|
2860 Sends a double-click message to the window procedure when the user double-clicks the mouse while the cursor is within a window belonging to the class.
|
|
|
2861 </summary>
|
|
|
2862 </member>
|
|
|
2863 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_DROPSHADOW">
|
|
|
2864 <summary>
|
|
|
2865 Windows XP: Enables the drop shadow effect on a window. The effect is turned on and off through SPI_SETDROPSHADOW. Typically, this is enabled for small, short-lived windows such as menus to emphasize their Z order relationship to other windows.
|
|
|
2866 </summary>
|
|
|
2867 </member>
|
|
|
2868 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_GLOBALCLASS">
|
|
|
2869 <summary>
|
|
|
2870 Specifies that the window class is an application global class. For more information, see Application Global Classes.
|
|
|
2871 </summary>
|
|
|
2872 </member>
|
|
|
2873 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_HREDRAW">
|
|
|
2874 <summary>
|
|
|
2875 Redraws the entire window if a movement or size adjustment changes the width of the client area.
|
|
|
2876 </summary>
|
|
|
2877 </member>
|
|
|
2878 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_NOCLOSE">
|
|
|
2879 <summary>
|
|
|
2880 Disables Close on the window menu.
|
|
|
2881 </summary>
|
|
|
2882 </member>
|
|
|
2883 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_OWNDC">
|
|
|
2884 <summary>
|
|
|
2885 Allocates a unique device context for each window in the class.
|
|
|
2886 </summary>
|
|
|
2887 </member>
|
|
|
2888 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_PARENTDC">
|
|
|
2889 <summary>
|
|
|
2890 Sets the clipping rectangle of the child window to that of the parent window so that the child can draw on the parent. A window with the CS_PARENTDC style bit receives a regular device context from the system's cache of device contexts. It does not give the child the parent's device context or device context settings. Specifying CS_PARENTDC enhances an application's performance.
|
|
|
2891 </summary>
|
|
|
2892 </member>
|
|
|
2893 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_SAVEBITS">
|
|
|
2894 <summary>
|
|
|
2895 Saves, as a bitmap, the portion of the screen image obscured by a window of this class. When the window is removed, the system uses the saved bitmap to restore the screen image, including other windows that were obscured. Therefore, the system does not send WM_PAINT messages to windows that were obscured if the memory used by the bitmap has not been discarded and if other screen actions have not invalidated the stored image. This style is useful for small windows (for example, menus or dialog boxes) that are displayed briefly and then removed before other screen activity takes place. This style increases the time required to display the window, because the system must first allocate memory to store the bitmap.
|
|
|
2896 </summary>
|
|
|
2897 </member>
|
|
|
2898 <member name="F:JetBrains.Interop.WinApi.WindowClassStyles.CS_VREDRAW">
|
|
|
2899 <summary>
|
|
|
2900 Redraws the entire window if a movement or size adjustment changes the height of the client area.
|
|
|
2901 </summary>
|
|
|
2902 </member>
|
|
|
2903 <member name="T:JetBrains.Interop.WinApi.WindowExStyles">
|
|
|
2904 <summary>
|
|
|
2905 Specifies the extended window style of the window being created.
|
|
|
2906 </summary>
|
|
|
2907 </member>
|
|
|
2908 <member name="T:JetBrains.Interop.WinApi.WindowStyles">
|
|
|
2909 <summary>
|
|
|
2910 The following styles can be specified wherever a window style is required. After the control has been created, these styles cannot be modified, except as noted.
|
|
|
2911 </summary>
|
|
|
2912 </member>
|
|
|
2913 <member name="T:JetBrains.Interop.WinApi.ShowWindowCommands">
|
|
|
2914 <summary>
|
|
|
2915 <see cref="M:JetBrains.Interop.WinApi.User32Dll.ShowWindow(System.Void*,System.Int32)"/> Commands.
|
|
|
2916 </summary>
|
|
|
2917 </member>
|
|
|
2918 <member name="T:JetBrains.Interop.WinApi.EditBoxControlMargins">
|
|
|
2919 <summary>
|
|
|
2920 <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.EM_SETMARGINS"/> constants.
|
|
|
2921 </summary>
|
|
|
2922 </member>
|
|
|
2923 <member name="F:JetBrains.Interop.WinApi.EditBoxControlMargins.EC_LEFTMARGIN">
|
|
|
2924 <summary>
|
|
|
2925 Sets the left margin.
|
|
|
2926 </summary>
|
|
|
2927 </member>
|
|
|
2928 <member name="F:JetBrains.Interop.WinApi.EditBoxControlMargins.EC_RIGHTMARGIN">
|
|
|
2929 <summary>
|
|
|
2930 Sets the right margin.
|
|
|
2931 </summary>
|
|
|
2932 </member>
|
|
|
2933 <member name="F:JetBrains.Interop.WinApi.EditBoxControlMargins.EC_USEFONTINFO">
|
|
|
2934 <summary>
|
|
|
2935 Rich edit controls: Sets the left and right margins to a narrow width calculated using the text metrics of the control's current font. If no font has been set for the control, the margins are set to zero. The lParam parameter is ignored. Edit controls: The EC_USEFONTINFO value cannot be used in the wParam parameter. It can only be used in the lParam parameter.
|
|
|
2936 </summary>
|
|
|
2937 </member>
|
|
|
2938 <member name="T:JetBrains.Interop.WinApi.MEMORYSTATUSEX">
|
|
|
2939 <summary>
|
|
|
2940 Helper structure for the <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.GlobalMemoryStatusEx(JetBrains.Interop.WinApi.MEMORYSTATUSEX*)"/> function.
|
|
|
2941 </summary>
|
|
|
2942 </member>
|
|
|
2943 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_DEST_TOO_SMALL">
|
|
|
2944 <summary>
|
|
|
2945 Visual Studio specific.
|
|
|
2946 </summary>
|
|
|
2947 </member>
|
|
|
2948 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_LOCKED">
|
|
|
2949 <summary>
|
|
|
2950 Visual Studio specific.
|
|
|
2951 </summary>
|
|
|
2952 </member>
|
|
|
2953 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_READONLY">
|
|
|
2954 <summary>
|
|
|
2955 Visual Studio specific.
|
|
|
2956 </summary>
|
|
|
2957 </member>
|
|
|
2958 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_READONLY_REGION">
|
|
|
2959 <summary>
|
|
|
2960 Visual Studio specific.
|
|
|
2961 </summary>
|
|
|
2962 </member>
|
|
|
2963 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_SCC_READONLY">
|
|
|
2964 <summary>
|
|
|
2965 Visual Studio specific.
|
|
|
2966 </summary>
|
|
|
2967 </member>
|
|
|
2968 <member name="F:JetBrains.Interop.WinApi.HResults.BUFFER_E_TIMEOUT">
|
|
|
2969 <summary>
|
|
|
2970 Visual Studio specific.
|
|
|
2971 </summary>
|
|
|
2972 </member>
|
|
|
2973 <member name="F:JetBrains.Interop.WinApi.HResults.MARKER_E_BUFFERDESTROYED">
|
|
|
2974 <summary>
|
|
|
2975 Visual Studio specific.
|
|
|
2976 </summary>
|
|
|
2977 </member>
|
|
|
2978 <member name="F:JetBrains.Interop.WinApi.HResults.MARKER_E_INVALIDATED">
|
|
|
2979 <summary>
|
|
|
2980 Visual Studio specific.
|
|
|
2981 </summary>
|
|
|
2982 </member>
|
|
|
2983 <member name="F:JetBrains.Interop.WinApi.HResults.VIEW_E_LOCATION_HIDDEN">
|
|
|
2984 <summary>
|
|
|
2985 Visual Studio specific.
|
|
|
2986 </summary>
|
|
|
2987 </member>
|
|
|
2988 <member name="F:JetBrains.Interop.WinApi.HResults.VIEW_E_NO_BOOKMARKS">
|
|
|
2989 <summary>
|
|
|
2990 Visual Studio specific.
|
|
|
2991 </summary>
|
|
|
2992 </member>
|
|
|
2993 <member name="F:JetBrains.Interop.WinApi.HResults.VIEW_E_NO_DEBUGGER">
|
|
|
2994 <summary>
|
|
|
2995 Visual Studio specific.
|
|
|
2996 </summary>
|
|
|
2997 </member>
|
|
|
2998 <member name="F:JetBrains.Interop.WinApi.HResults.VIEW_E_USERREADONLY">
|
|
|
2999 <summary>
|
|
|
3000 Visual Studio specific.
|
|
|
3001 </summary>
|
|
|
3002 </member>
|
|
|
3003 <member name="F:JetBrains.Interop.WinApi.HResults.LINKEDUNDO_E_INTERVENING_ACTION">
|
|
|
3004 <summary>
|
|
|
3005 Visual Studio specific.
|
|
|
3006 </summary>
|
|
|
3007 </member>
|
|
|
3008 <member name="F:JetBrains.Interop.WinApi.HResults.UNDO_E_CLIENTABORT">
|
|
|
3009 <summary>
|
|
|
3010 Visual Studio specific.
|
|
|
3011 </summary>
|
|
|
3012 </member>
|
|
|
3013 <member name="F:JetBrains.Interop.WinApi.HResults.TIP_S_ONLYIFNOMARKER">
|
|
|
3014 <summary>
|
|
|
3015 Visual Studio specific.
|
|
|
3016 </summary>
|
|
|
3017 </member>
|
|
|
3018 <member name="F:JetBrains.Interop.WinApi.HResults.STG_E_INVALIDCODEPAGE">
|
|
|
3019 <summary>
|
|
|
3020 Visual Studio specific.
|
|
|
3021 </summary>
|
|
|
3022 </member>
|
|
|
3023 <member name="F:JetBrains.Interop.WinApi.HResults.STG_E_NOTTEXT">
|
|
|
3024 <summary>
|
|
|
3025 Visual Studio specific.
|
|
|
3026 </summary>
|
|
|
3027 </member>
|
|
|
3028 <member name="F:JetBrains.Interop.WinApi.HResults.STG_S_DATALOSS">
|
|
|
3029 <summary>
|
|
|
3030 Visual Studio specific.
|
|
|
3031 </summary>
|
|
|
3032 </member>
|
|
|
3033 <member name="T:JetBrains.Interop.WinApi.GetAncestorFlags">
|
|
|
3034 <summary>
|
|
|
3035 Flags for the <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetAncestor(System.Void*,System.UInt32)"/> function.
|
|
|
3036 </summary>
|
|
|
3037 </member>
|
|
|
3038 <member name="F:JetBrains.Interop.WinApi.GetAncestorFlags.GA_PARENT">
|
|
|
3039 <summary>
|
|
|
3040 Retrieves the parent window. This does not include the owner, as it does with the GetParent function.
|
|
|
3041 </summary>
|
|
|
3042 </member>
|
|
|
3043 <member name="F:JetBrains.Interop.WinApi.GetAncestorFlags.GA_ROOT">
|
|
|
3044 <summary>
|
|
|
3045 Retrieves the root window by walking the chain of parent windows.
|
|
|
3046 </summary>
|
|
|
3047 </member>
|
|
|
3048 <member name="F:JetBrains.Interop.WinApi.GetAncestorFlags.GA_ROOTOWNER">
|
|
|
3049 <summary>
|
|
|
3050 Retrieves the owned root window by walking the chain of parent and owner windows returned by GetParent.
|
|
|
3051 </summary>
|
|
|
3052 </member>
|
|
|
3053 <member name="F:JetBrains.Interop.WinApi.SYSTEM_INFO.wProcessorArchitecture">
|
|
|
3054 <seealso cref="T:JetBrains.Interop.WinApi.ProcessorArchitecture"/>
|
|
|
3055 </member>
|
|
|
3056 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS">
|
|
|
3057 <summary>
|
|
|
3058 The <c>WINDOWPOS</c> structure contains information about the size and position of a window.
|
|
|
3059 </summary>
|
|
|
3060 </member>
|
|
|
3061 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.hwnd">
|
|
|
3062 <summary>
|
|
|
3063 Handle to the window.
|
|
|
3064 </summary>
|
|
|
3065 </member>
|
|
|
3066 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.hwndInsertAfter">
|
|
|
3067 <summary>
|
|
|
3068 Specifies the position of the window in Z order (front-to-back position). This member can be a handle to the window behind which this window is placed, or can be one of the special values listed with the SetWindowPos function.
|
|
|
3069 </summary>
|
|
|
3070 </member>
|
|
|
3071 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.x">
|
|
|
3072 <summary>
|
|
|
3073 Specifies the position of the left edge of the window.
|
|
|
3074 </summary>
|
|
|
3075 </member>
|
|
|
3076 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.y">
|
|
|
3077 <summary>
|
|
|
3078 Specifies the position of the top edge of the window.
|
|
|
3079 </summary>
|
|
|
3080 </member>
|
|
|
3081 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.cx">
|
|
|
3082 <summary>
|
|
|
3083 Specifies the window width, in pixels.
|
|
|
3084 </summary>
|
|
|
3085 </member>
|
|
|
3086 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.cy">
|
|
|
3087 <summary>
|
|
|
3088 Specifies the window height, in pixels.
|
|
|
3089 </summary>
|
|
|
3090 </member>
|
|
|
3091 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.WINDOWPOS.flags">
|
|
|
3092 <summary>
|
|
|
3093 Specifies the window position. This member can be one or more of the following values. See <see cref="T:JetBrains.Interop.WinApi.SetWindowPosFlags"/> for details.
|
|
|
3094 </summary>
|
|
|
3095 </member>
|
|
|
3096 <member name="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoSizeW(System.String,System.UInt32*)">
|
|
|
3097 <summary>
|
|
|
3098 Determines whether the operating system can retrieve version information for a specified file. If version information is available, <see cref="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoSizeW(System.String,System.UInt32*)"/> returns the size, in bytes, of that information.
|
|
|
3099 </summary>
|
|
|
3100 <param name="lptstrFilename">[in] Pointer to a null-terminated string that specifies the name of the file of interest. The function uses the search sequence specified by the LoadLibrary function. Windows 95/98/Me: The short path form of the specified file name must be less than 126 characters.</param>
|
|
|
3101 <param name="lpdwHandle">[out] Pointer to a variable that the function sets to zero.</param>
|
|
|
3102 <returns>If the function succeeds, the return value is the size, in bytes, of the file's version information. If the function fails, the return value is zero. To get extended error information, call GetLastError.</returns>
|
|
|
3103 </member>
|
|
|
3104 <member name="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoW(System.String,System.UInt32,System.UInt32,System.Void*)">
|
|
|
3105 <summary>
|
|
|
3106 Retrieves version information for the specified file.
|
|
|
3107 </summary>
|
|
|
3108 <param name="lptstrFilename">[in] Pointer to a null-terminated string that specifies the name of the file of interest. If a full path is not specified, the function uses the search sequence specified by the LoadLibrary function.Windows 95/98/Me: The short path form of the specified file name must be less than 126 characters.</param>
|
|
|
3109 <param name="dwHandle">This parameter is ignored.</param>
|
|
|
3110 <param name="dwLen">[in] Specifies the size, in bytes, of the buffer pointed to by the lpData parameter. Call the <see cref="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoSizeW(System.String,System.UInt32*)"/> function first to determine the size, in bytes, of a file's version information. The dwLen member should be equal to or greater than that value. If the buffer pointed to by lpData is not large enough, the function truncates the file's version information to the size of the buffer.</param>
|
|
|
3111 <param name="lpData">[out] Pointer to a buffer that receives the file-version information. You can use this value in a subsequent call to the <see cref="M:JetBrains.Interop.WinApi.VersionDll.VerQueryValueW(System.Void*,System.String,System.Void**,System.UInt32*)"/> function to retrieve data from the buffer.</param>
|
|
|
3112 <returns>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.</returns>
|
|
|
3113 </member>
|
|
|
3114 <member name="M:JetBrains.Interop.WinApi.VersionDll.VerQueryValueW(System.Void*,System.String,System.Void**,System.UInt32*)">
|
|
|
3115 <summary>
|
|
|
3116 The <see cref="M:JetBrains.Interop.WinApi.VersionDll.VerQueryValueW(System.Void*,System.String,System.Void**,System.UInt32*)"/> function retrieves specified version information from the specified version-information resource. To retrieve the appropriate resource, before you call <see cref="M:JetBrains.Interop.WinApi.VersionDll.VerQueryValueW(System.Void*,System.String,System.Void**,System.UInt32*)"/>, you must first call the <see cref="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoSizeW(System.String,System.UInt32*)"/> function, and then the <see cref="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoW(System.String,System.UInt32,System.UInt32,System.Void*)"/> function.
|
|
|
3117 </summary>
|
|
|
3118 <param name="pBlock">[in] Pointer to the buffer containing the version-information resource returned by the <see cref="M:JetBrains.Interop.WinApi.VersionDll.GetFileVersionInfoW(System.String,System.UInt32,System.UInt32,System.Void*)"/> function. </param>
|
|
|
3119 <param name="lpSubBlock">[in] Pointer to a zero-terminated string specifying which version-information value to retrieve. The string must consist of names separated by backslashes (\) and it must have one of the following forms.
|
|
|
3120 <para><c>\</c></para>
|
|
|
3121 <para>Specifies the root block. The function retrieves a pointer to the VS_FIXEDFILEINFO structure for the version-information resource.</para>
|
|
|
3122 <para><c>\VarFileInfo\Translation</c></para>
|
|
|
3123 <para>Specifies the translation array in a Var variable information structure—the Value member of this structure. The function retrieves a pointer to this array of language and code page identifiers. An application can use these identifiers to access a language-specific StringTable /// structure (using the szKey member) in the version-information resource.</para>
|
|
|
3124 <para><c>\StringFileInfo\lang-codepage\string-name</c></para>
|
|
|
3125 <para>Specifies a value in a language-specific StringTable structure. The lang-codepage name is a concatenation of a language and code page identifier pair found as a DWORD in the translation array for the resource. Here the lang-codepage name must be specified as a hexadecimal string. The string-name name must be one of the predefined strings described in the following Remarks section. The function retrieves a string value specific to the language and code page indicated. </para>
|
|
|
3126 </param>
|
|
|
3127 <param name="lplpBuffer">[out] When this method returns, contains the address of a pointer to the requested version information in the buffer pointed to by pBlock. The memory pointed to by lplpBuffer is freed when the associated pBlock memory is freed. </param>
|
|
|
3128 <param name="puLen">[out] When this method returns, contains a pointer to the size of the requested data pointed to by lplpBuffer: for version information values, the length in TCHARs of the string stored at lplpBuffer; for translation array values, the size in bytes of the array stored at lplpBuffer; and for root block, the size in bytes of the structure.</param>
|
|
|
3129 <returns>If the specified version-information structure exists, and version information is available, the return value is nonzero. If the address of the length buffer is zero, no value is available for the specified version-information name. If the specified name does not exist or the specified resource is not valid, the return value is zero.</returns>
|
|
|
3130 </member>
|
|
|
3131 <member name="M:JetBrains.Interop.WinApi.VersionDll.Helpers.GetFileVersionInfo(System.String)">
|
|
|
3132 <summary>
|
|
|
3133 Gets the WinAPI file version of a native file.
|
|
|
3134 </summary>
|
|
|
3135 </member>
|
|
|
3136 <member name="T:JetBrains.Interop.WinApi.WinInetDll">
|
|
|
3137 <summary>
|
|
|
3138 WinInet.dll functions.
|
|
|
3139 Must be 64bit-safe.
|
|
|
3140 </summary>
|
|
|
3141 </member>
|
|
|
3142 <member name="M:JetBrains.Interop.WinApi.WinInetDll.Helpers.InternetGetCookie(System.String)">
|
|
|
3143 <summary>
|
|
|
3144 Gets the system HTTP cookie.
|
|
|
3145 </summary>
|
|
|
3146 </member>
|
|
|
3147 <member name="M:JetBrains.Interop.WinApi.WinInetDll.Helpers.InternetSetCookie(System.String,System.String)">
|
|
|
3148 <summary>
|
|
|
3149 Sets a system HTTP cookie.
|
|
|
3150 </summary>
|
|
|
3151 </member>
|
|
|
3152 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.DibColors">
|
|
|
3153 <summary>
|
|
|
3154 Color usage constants for <see cref="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateDIBSection(System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO*,System.UInt32,System.Void**,System.Void*,System.Int32)"/>, <see cref="M:JetBrains.Interop.WinApi.Gdi32Dll.CreateDIBitmap(System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFOHEADER*,System.UInt32,System.Void*,JetBrains.Interop.WinApi.Declarations.Structures.BITMAPINFO*,System.UInt32)"/>.
|
|
|
3155 </summary>
|
|
|
3156 </member>
|
|
|
3157 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DibColors.DIB_RGB_COLORS">
|
|
|
3158 <summary>
|
|
|
3159 The BITMAPINFO structure contains an array of literal RGB values.
|
|
|
3160 </summary>
|
|
|
3161 </member>
|
|
|
3162 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DibColors.DIB_PAL_COLORS">
|
|
|
3163 <summary>
|
|
|
3164 The bmiColors member is an array of 16-bit indexes into the logical palette of the device context specified by hdc.
|
|
|
3165 </summary>
|
|
|
3166 </member>
|
|
|
3167 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.DRIVERVERSION">
|
|
|
3168 <summary>
|
|
|
3169 Device driver version
|
|
|
3170 </summary>
|
|
|
3171 </member>
|
|
|
3172 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.TECHNOLOGY">
|
|
|
3173 <summary>
|
|
|
3174 Device classification
|
|
|
3175 </summary>
|
|
|
3176 </member>
|
|
|
3177 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.HORZSIZE">
|
|
|
3178 <summary>
|
|
|
3179 Horizontal size in millimeters
|
|
|
3180 </summary>
|
|
|
3181 </member>
|
|
|
3182 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.VERTSIZE">
|
|
|
3183 <summary>
|
|
|
3184 Vertical size in millimeters
|
|
|
3185 </summary>
|
|
|
3186 </member>
|
|
|
3187 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.HORZRES">
|
|
|
3188 <summary>
|
|
|
3189 Horizontal width in pixels
|
|
|
3190 </summary>
|
|
|
3191 </member>
|
|
|
3192 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.VERTRES">
|
|
|
3193 <summary>
|
|
|
3194 Vertical height in pixels
|
|
|
3195 </summary>
|
|
|
3196 </member>
|
|
|
3197 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.BITSPIXEL">
|
|
|
3198 <summary>
|
|
|
3199 Number of bits per pixel
|
|
|
3200 </summary>
|
|
|
3201 </member>
|
|
|
3202 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PLANES">
|
|
|
3203 <summary>
|
|
|
3204 Number of planes
|
|
|
3205 </summary>
|
|
|
3206 </member>
|
|
|
3207 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMBRUSHES">
|
|
|
3208 <summary>
|
|
|
3209 Number of brushes the device has
|
|
|
3210 </summary>
|
|
|
3211 </member>
|
|
|
3212 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMPENS">
|
|
|
3213 <summary>
|
|
|
3214 Number of pens the device has
|
|
|
3215 </summary>
|
|
|
3216 </member>
|
|
|
3217 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMMARKERS">
|
|
|
3218 <summary>
|
|
|
3219 Number of markers the device has
|
|
|
3220 </summary>
|
|
|
3221 </member>
|
|
|
3222 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMFONTS">
|
|
|
3223 <summary>
|
|
|
3224 Number of fonts the device has
|
|
|
3225 </summary>
|
|
|
3226 </member>
|
|
|
3227 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMCOLORS">
|
|
|
3228 <summary>
|
|
|
3229 Number of colors the device supports
|
|
|
3230 </summary>
|
|
|
3231 </member>
|
|
|
3232 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PDEVICESIZE">
|
|
|
3233 <summary>
|
|
|
3234 Size required for device descriptor
|
|
|
3235 </summary>
|
|
|
3236 </member>
|
|
|
3237 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.CURVECAPS">
|
|
|
3238 <summary>
|
|
|
3239 Curve capabilities
|
|
|
3240 </summary>
|
|
|
3241 </member>
|
|
|
3242 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.LINECAPS">
|
|
|
3243 <summary>
|
|
|
3244 Line capabilities
|
|
|
3245 </summary>
|
|
|
3246 </member>
|
|
|
3247 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.POLYGONALCAPS">
|
|
|
3248 <summary>
|
|
|
3249 Polygonal capabilities
|
|
|
3250 </summary>
|
|
|
3251 </member>
|
|
|
3252 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.TEXTCAPS">
|
|
|
3253 <summary>
|
|
|
3254 Text capabilities
|
|
|
3255 </summary>
|
|
|
3256 </member>
|
|
|
3257 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.CLIPCAPS">
|
|
|
3258 <summary>
|
|
|
3259 Clipping capabilities
|
|
|
3260 </summary>
|
|
|
3261 </member>
|
|
|
3262 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.RASTERCAPS">
|
|
|
3263 <summary>
|
|
|
3264 Bitblt capabilities
|
|
|
3265 </summary>
|
|
|
3266 </member>
|
|
|
3267 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.ASPECTX">
|
|
|
3268 <summary>
|
|
|
3269 Length of the X leg
|
|
|
3270 </summary>
|
|
|
3271 </member>
|
|
|
3272 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.ASPECTY">
|
|
|
3273 <summary>
|
|
|
3274 Length of the Y leg
|
|
|
3275 </summary>
|
|
|
3276 </member>
|
|
|
3277 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.ASPECTXY">
|
|
|
3278 <summary>
|
|
|
3279 Length of the hypotenuse
|
|
|
3280 </summary>
|
|
|
3281 </member>
|
|
|
3282 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.SHADEBLENDCAPS">
|
|
|
3283 <summary>
|
|
|
3284 Shading and Blending caps
|
|
|
3285 </summary>
|
|
|
3286 </member>
|
|
|
3287 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.LOGPIXELSX">
|
|
|
3288 <summary>
|
|
|
3289 Logical pixels inch in X
|
|
|
3290 </summary>
|
|
|
3291 </member>
|
|
|
3292 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.LOGPIXELSY">
|
|
|
3293 <summary>
|
|
|
3294 Logical pixels inch in Y
|
|
|
3295 </summary>
|
|
|
3296 </member>
|
|
|
3297 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.SIZEPALETTE">
|
|
|
3298 <summary>
|
|
|
3299 Number of entries in physical palette
|
|
|
3300 </summary>
|
|
|
3301 </member>
|
|
|
3302 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.NUMRESERVED">
|
|
|
3303 <summary>
|
|
|
3304 Number of reserved entries in palette
|
|
|
3305 </summary>
|
|
|
3306 </member>
|
|
|
3307 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.COLORRES">
|
|
|
3308 <summary>
|
|
|
3309 Actual color resolution
|
|
|
3310 </summary>
|
|
|
3311 </member>
|
|
|
3312 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PHYSICALWIDTH">
|
|
|
3313 <summary>
|
|
|
3314 Physical Width in device units
|
|
|
3315 </summary>
|
|
|
3316 </member>
|
|
|
3317 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PHYSICALHEIGHT">
|
|
|
3318 <summary>
|
|
|
3319 Physical Height in device units
|
|
|
3320 </summary>
|
|
|
3321 </member>
|
|
|
3322 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PHYSICALOFFSETX">
|
|
|
3323 <summary>
|
|
|
3324 Physical Printable Area x margin
|
|
|
3325 </summary>
|
|
|
3326 </member>
|
|
|
3327 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.PHYSICALOFFSETY">
|
|
|
3328 <summary>
|
|
|
3329 Physical Printable Area y margin
|
|
|
3330 </summary>
|
|
|
3331 </member>
|
|
|
3332 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.SCALINGFACTORX">
|
|
|
3333 <summary>
|
|
|
3334 Scaling factor x
|
|
|
3335 </summary>
|
|
|
3336 </member>
|
|
|
3337 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.SCALINGFACTORY">
|
|
|
3338 <summary>
|
|
|
3339 Scaling factor y
|
|
|
3340 </summary>
|
|
|
3341 </member>
|
|
|
3342 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.VREFRESH">
|
|
|
3343 <summary>
|
|
|
3344 Current vertical refresh rate of the display device (for displays only) in Hz
|
|
|
3345 </summary>
|
|
|
3346 </member>
|
|
|
3347 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.DESKTOPVERTRES">
|
|
|
3348 <summary>
|
|
|
3349 Horizontal width of entire desktop in pixels
|
|
|
3350 </summary>
|
|
|
3351 </member>
|
|
|
3352 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.DESKTOPHORZRES">
|
|
|
3353 <summary>
|
|
|
3354 Vertical height of entire desktop in pixels
|
|
|
3355 </summary>
|
|
|
3356 </member>
|
|
|
3357 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.DeviceCapabilityIndex.BLTALIGNMENT">
|
|
|
3358 <summary>
|
|
|
3359 Preferred blt alignment
|
|
|
3360 </summary>
|
|
|
3361 </member>
|
|
|
3362 <member name="T:JetBrains.Interop.WinApi.Modules.UI.ControlPaintUnsafe">
|
|
|
3363 <summary>
|
|
|
3364 Encapsulates the utility classes for painting the controls.
|
|
|
3365 </summary>
|
|
|
3366 </member>
|
|
|
3367 <member name="T:JetBrains.Util.NoReorder">
|
|
|
3368 <summary>
|
|
|
3369 Prevents the Member Reordering feature from tossing members of the marked class.
|
|
|
3370 </summary>
|
|
|
3371 <remarks>
|
|
|
3372 The attribute must be mentioned in your member reordering patterns.
|
|
|
3373 </remarks>
|
|
|
3374 </member>
|
|
|
3375 <member name="T:JetBrains.Interop.WinApi.User32Dll">
|
|
|
3376 <summary>
|
|
|
3377 User32.dll functions.
|
|
|
3378 Must be 64bit-safe.
|
|
|
3379 </summary>
|
|
|
3380 <remarks>
|
|
|
3381 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
3382 (1) All the function declarations MUST be 64-bit aware.
|
|
|
3383 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
3384 and you MUST ensure that each parameter has a proper size.
|
|
|
3385 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
3386 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
3387 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
3388 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
3389 but slows down the execution of critical members.
|
|
|
3390 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
3391 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
3392 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
3393 This greately improves the understanding of the parameter sizes.
|
|
|
3394 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
3395 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
3396 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
3397 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
3398 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
3399 (A) Same rules must apply to members of the structures.
|
|
|
3400 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
3401 </remarks>
|
|
|
3402 </member>
|
|
|
3403 <member name="M:JetBrains.Interop.WinApi.User32Dll.BringWindowToTop(System.Void*)">
|
|
|
3404 <summary>
|
|
|
3405 The BringWindowToTop function brings the specified window to the top of the Z order. If the window is a top-level
|
|
|
3406 window, it is activated. If the window is a child window, the top-level parent window associated with the child window is activated.
|
|
|
3407 </summary>
|
|
|
3408 </member>
|
|
|
3409 <member name="M:JetBrains.Interop.WinApi.User32Dll.ClientToScreen(System.Void*,JetBrains.Interop.WinApi.POINT*)">
|
|
|
3410 <summary>
|
|
|
3411 The ClientToScreen function converts the client-area coordinates of a specified point to screen coordinates.
|
|
|
3412 </summary>
|
|
|
3413 <param name="hWnd">[in] Handle to the window whose client area is used for the conversion. </param>
|
|
|
3414 <param name="lpPoint">[in/out] Pointer to a POINT structure that contains the client coordinates to be converted. The new screen coordinates are copied into this structure if the function succeeds. </param>
|
|
|
3415 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
3416 </member>
|
|
|
3417 <member name="M:JetBrains.Interop.WinApi.User32Dll.CreateDesktopW(System.String,System.String,System.Void*,System.UInt32,System.UInt32,System.Void*)">
|
|
|
3418 <summary>
|
|
|
3419 Creates a new desktop, associates it with the current window station of the calling process, and assigns it to the calling thread. The calling process must have an associated window station, either assigned by the system at process creation time or set by the SetProcessWindowStation function.
|
|
|
3420 </summary>
|
|
|
3421 <param name="lpszDesktop">The name of the desktop to be created. Desktop names are case-insensitive and may not contain backslash characters (\).</param>
|
|
|
3422 <param name="lpszDevice">Reserved; must be NULL.</param>
|
|
|
3423 <param name="pDevmode">Reserved; must be NULL.</param>
|
|
|
3424 <param name="dwFlags">This parameter can be zero or the following value. <c>DF_ALLOWOTHERACCOUNTHOOK</c> <c>0x0001</c> Enables processes running in other accounts on the desktop to set hooks in this process. </param>
|
|
|
3425 <param name="dwDesiredAccess">The access to the desktop. For a list of values, see Desktop Security and Access Rights. This parameter must include the DESKTOP_CREATEWINDOW access right, because internally CreateDesktop uses the handle to create a window.</param>
|
|
|
3426 <param name="lpsa">A pointer to a SECURITY_ATTRIBUTES structure that determines whether the returned handle can be inherited by child processes. If lpsa is NULL, the handle cannot be inherited. The lpSecurityDescriptor member of the structure specifies a security descriptor for the new desktop. If this parameter is NULL, the desktop inherits its security descriptor from the parent window station.</param>
|
|
|
3427 <returns>If the function succeeds, the return value is a handle to the newly created desktop. If the specified desktop already exists, the function succeeds and returns a handle to the existing desktop. When you are finished using the handle, call the CloseDesktop function to close it. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3428 </member>
|
|
|
3429 <member name="M:JetBrains.Interop.WinApi.User32Dll.DestroyIcon(System.Void*)">
|
|
|
3430 <summary>
|
|
|
3431 Destroys an icon and frees any memory the icon occupied.
|
|
|
3432 </summary>
|
|
|
3433 <param name="hIcon">[in] Handle to the icon to be destroyed. The icon must not be in use. </param>
|
|
|
3434 <returns>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. </returns>
|
|
|
3435 <remarks>
|
|
|
3436 It is only necessary to call DestroyIcon for icons and cursors created with the following functions: CreateIconFromResourceEx (if called without the LR_SHARED flag), CreateIconIndirect, and CopyIcon. Do not use this function to destroy a shared icon. A shared icon is valid as long as the module from which it was loaded remains in memory. The following functions obtain a shared icon: LoadIcon, LoadImage (if you use the LR_SHARED flag), CopyImage (if you use the LR_COPYRETURNORG flag and the hImage parameter is a shared icon), CreateIconFromResource, CreateIconFromResourceEx (if you use the LR_SHARED flag)
|
|
|
3437 </remarks>
|
|
|
3438 </member>
|
|
|
3439 <member name="M:JetBrains.Interop.WinApi.User32Dll.DestroyWindow(System.Void*)">
|
|
|
3440 <summary>
|
|
|
3441 The DestroyWindow function destroys the specified window. The function sends WM_DESTROY and WM_NCDESTROY messages to the window to deactivate it and remove the keyboard focus from it. The function also destroys the window's menu, flushes the thread message queue, destroys timers, removes clipboard ownership, and breaks the clipboard viewer chain (if the window is at the top of the viewer chain). If the specified window is a parent or owner window, DestroyWindow automatically destroys the associated child or owned windows when it destroys the parent or owner window. The function first destroys child or owned windows, and then it destroys the parent or owner window. DestroyWindow also destroys modeless dialog boxes created by the CreateDialog function.
|
|
|
3442 </summary>
|
|
|
3443 </member>
|
|
|
3444 <member name="M:JetBrains.Interop.WinApi.User32Dll.DispatchMessageW(JetBrains.Interop.WinApi.MSG*)">
|
|
|
3445 <summary>
|
|
|
3446 The DispatchMessage function dispatches a message to a window procedure. It is typically used to dispatch a message retrieved by the GetMessage function.
|
|
|
3447 </summary>
|
|
|
3448 <param name="lpmsg">[in] Pointer to an MSG structure that contains the message.</param>
|
|
|
3449 <returns>The return value specifies the value returned by the window procedure. Although its meaning depends on the message being dispatched, the return value generally is ignored.</returns>
|
|
|
3450 </member>
|
|
|
3451 <member name="M:JetBrains.Interop.WinApi.User32Dll.EnableWindow(System.Void*,System.Int32)">
|
|
|
3452 <summary>
|
|
|
3453 The EnableWindow function enables or disables mouse and keyboard input to the specified window or control. When input is disabled, the window does not receive input such as mouse clicks and key presses. When input is enabled, the window receives all input.
|
|
|
3454 </summary>
|
|
|
3455 <param name="hWnd">[in] Handle to the window to be enabled or disabled.</param>
|
|
|
3456 <param name="bEnable">[in] Specifies whether to enable or disable the window. If this parameter is TRUE, the window is enabled. If the parameter is FALSE, the window is disabled.</param>
|
|
|
3457 <returns>If the window was previously disabled, the return value is nonzero. If the window was not previously disabled, the return value is zero.</returns>
|
|
|
3458 </member>
|
|
|
3459 <member name="M:JetBrains.Interop.WinApi.User32Dll.EnumChildWindows(System.Void*,System.Void*,System.IntPtr)">
|
|
|
3460 <summary>
|
|
|
3461 The EnumChildWindows function enumerates the child windows that belong to the specified parent window by passing the handle to each child window, in turn, to an application-defined callback function. EnumChildWindows continues until the last child window is enumerated or the callback function returns FALSE.
|
|
|
3462 </summary>
|
|
|
3463 <param name="hWndParent">[in] Handle to the parent window whose child windows are to be enumerated. If this parameter is NULL, this function is equivalent to EnumWindows. Windows 95/98/Me: hWndParent cannot be NULL.</param>
|
|
|
3464 <param name="lpEnumFunc">[in] Pointer to an application-defined callback function. For more information, see EnumChildProc.</param>
|
|
|
3465 <param name="lParam">[in] Specifies an application-defined value to be passed to the callback function.</param>
|
|
|
3466 <returns>Not used.</returns>
|
|
|
3467 <remarks>If a child window has created child windows of its own, EnumChildWindows enumerates those windows as well. A child window that is moved or repositioned in the Z order during the enumeration process will be properly enumerated. The function does not enumerate a child window that is destroyed before being enumerated or that is created during the enumeration process. </remarks>
|
|
|
3468 </member>
|
|
|
3469 <member name="M:JetBrains.Interop.WinApi.User32Dll.EnumThreadWindows(System.UInt32,System.Void*,System.IntPtr)">
|
|
|
3470 <summary>
|
|
|
3471 The EnumThreadWindows function enumerates all nonchild windows associated with a thread by passing the handle to each window, in turn, to an application-defined callback function. EnumThreadWindows continues until the last window is enumerated or the callback function returns FALSE. To enumerate child windows of a particular window, use the EnumChildWindows function.
|
|
|
3472 </summary>
|
|
|
3473 <param name="dwThreadId">[in] Identifies the thread whose windows are to be enumerated. </param>
|
|
|
3474 <param name="lpfn">[in] Pointer to an application-defined callback function. For more information, see EnumThreadWndProc. </param>
|
|
|
3475 <param name="lParam">[in] Specifies an application-defined value to be passed to the callback function. </param>
|
|
|
3476 <returns>If the callback function returns TRUE for all windows in the thread specified by dwThreadId, the return value is TRUE. If the callback function returns FALSE on any enumerated window, or if there are no windows found in the thread specified by dwThreadId, the return value is FALSE.</returns>
|
|
|
3477 </member>
|
|
|
3478 <member name="M:JetBrains.Interop.WinApi.User32Dll.EnumWindows(System.Void*,System.IntPtr)">
|
|
|
3479 <summary>
|
|
|
3480 The EnumWindows function enumerates all top-level windows on the screen by passing the handle to each window, in turn, to an application-defined callback function. EnumWindows continues until the last top-level window is enumerated or the callback function returns FALSE.
|
|
|
3481 </summary>
|
|
|
3482 <param name="lpEnumFunc">[in] Pointer to an application-defined callback function. For more information, see EnumWindowsProc. </param>
|
|
|
3483 <param name="lParam">[in] Specifies an application-defined value to be passed to the callback function. </param>
|
|
|
3484 <returns>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. If EnumWindowsProc returns zero, the return value is also zero. In this case, the callback function should call SetLastError to obtain a meaningful error code to be returned to the caller of EnumWindows. </returns>
|
|
|
3485 <remarks>
|
|
|
3486 The EnumWindows function does not enumerate child windows, with the exception of a few top-level windows owned by the system that have the WS_CHILD style.
|
|
|
3487 This function is more reliable than calling the GetWindow function in a loop. An application that calls GetWindow to perform this task risks being caught in an infinite loop or referencing a handle to a window that has been destroyed.
|
|
|
3488 </remarks>
|
|
|
3489 </member>
|
|
|
3490 <member name="M:JetBrains.Interop.WinApi.User32Dll.FillRect(System.Void*,JetBrains.Interop.WinApi.RECT*,System.Void*)">
|
|
|
3491 <summary>
|
|
|
3492 The FillRect function fills a rectangle by using the specified brush. This function includes the left and top borders, but excludes the right and bottom borders of the rectangle.
|
|
|
3493 </summary>
|
|
|
3494 </member>
|
|
|
3495 <member name="M:JetBrains.Interop.WinApi.User32Dll.FlashWindowEx(JetBrains.Interop.WinApi.Declarations.Structures.FLASHWINFO*)">
|
|
|
3496 <summary>
|
|
|
3497 The SetForegroundWindow function puts the thread that created the specified window into the foreground and
|
|
|
3498 activates the window. Keyboard input is directed to the window, and various visual cues are changed for the user.
|
|
|
3499 The system assigns a slightly higher priority to the thread that created the foreground window than it does to other threads.
|
|
|
3500 </summary>
|
|
|
3501 </member>
|
|
|
3502 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetActiveWindow">
|
|
|
3503 <summary>
|
|
|
3504 The GetActiveWindow function retrieves the window handle to the active window attached to the calling thread's message queue.
|
|
|
3505 </summary>
|
|
|
3506 <returns>The return value is the handle to the active window attached to the calling thread's message queue. Otherwise, the return value is NULL. </returns>
|
|
|
3507 <remarks>To get the handle to the foreground window, you can use GetForegroundWindow. Windows 98/Me and Windows NT 4.0 SP3 and later: To get the window handle to the active window in the message queue for another thread, use GetGUIThreadInfo.</remarks>
|
|
|
3508 </member>
|
|
|
3509 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetAncestor(System.Void*,System.UInt32)">
|
|
|
3510 <summary>
|
|
|
3511 The GetAncestor function retrieves the handle to the ancestor of the specified window.
|
|
|
3512 </summary>
|
|
|
3513 <param name="hwnd">[in] Handle to the window whose ancestor is to be retrieved. If this parameter is the desktop window, the function returns <c>NULL</c>. </param>
|
|
|
3514 <param name="gaFlags">[in] Specifies the ancestor to be retrieved. This parameter can be one of the following values.</param>
|
|
|
3515 <returns>The return value is the handle to the ancestor window.</returns>
|
|
|
3516 </member>
|
|
|
3517 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetClassNameW(System.Void*,System.Char*,System.Int32)">
|
|
|
3518 <summary>
|
|
|
3519 The GetClassName function retrieves the name of the class to which the specified window belongs.
|
|
|
3520 </summary>
|
|
|
3521 <param name="hWnd">[in] Handle to the window and, indirectly, the class to which the window belongs. </param>
|
|
|
3522 <param name="lpClassName">[out] Pointer to the buffer that is to receive the class name string. </param>
|
|
|
3523 <param name="nMaxCount">[in] Specifies the length, in TCHAR, of the buffer pointed to by the lpClassName parameter. The class name string is truncated if it is longer than the buffer and is always null-terminated. </param>
|
|
|
3524 <returns>If the function succeeds, the return value is the number of TCHAR copied to the specified buffer. If the function fails, the return value is zero. To get extended error information, call GetLastError. </returns>
|
|
|
3525 </member>
|
|
|
3526 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetClientRect(System.Void*,JetBrains.Interop.WinApi.RECT*)">
|
|
|
3527 <summary>
|
|
|
3528 The GetClientRect function retrieves the coordinates of a window's client area. The client coordinates specify the upper-left and lower-right corners of the client area. Because client coordinates are relative to the upper-left corner of a window's client area, the coordinates of the upper-left corner are (0,0).
|
|
|
3529 </summary>
|
|
|
3530 <param name="hWnd">[in] Handle to the window whose client coordinates are to be retrieved. </param>
|
|
|
3531 <param name="lpRect">[out] Pointer to a RECT structure that receives the client coordinates. The left and top members are zero. The right and bottom members contain the width and height of the window. </param>
|
|
|
3532 <returns>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.</returns>
|
|
|
3533 <remarks>In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words, the pixel at (right, bottom) lies immediately outside the rectangle.</remarks>
|
|
|
3534 </member>
|
|
|
3535 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetCursorInfo(JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO*)">
|
|
|
3536 <summary>
|
|
|
3537 The GetCursorInfo function retrieves information about the global cursor.
|
|
|
3538 </summary>
|
|
|
3539 <param name="pci">Pointer to a CURSORINFO structure that receives the information. Note that you must set CURSORINFO.cbSize to sizeof(CURSORINFO) before calling this function.</param>
|
|
|
3540 <returns>If the function succeeds, the return value is nonzero.
|
|
|
3541 If the function fails, the return value is zero. To get extended error information, call GetLastError.</returns>
|
|
|
3542 </member>
|
|
|
3543 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetCursorPos(JetBrains.Interop.WinApi.POINT*)">
|
|
|
3544 <summary>
|
|
|
3545 Retrieves the cursor's position, in screen coordinates.
|
|
|
3546 </summary>
|
|
|
3547 <param name="lpPoint">[out] Pointer to a POINT structure that receives the screen coordinates of the cursor.</param>
|
|
|
3548 <returns>Returns nonzero if successful or zero otherwise. To get extended error information, call GetLastError.</returns>
|
|
|
3549 </member>
|
|
|
3550 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetDlgItem(System.Void*,System.Int32)">
|
|
|
3551 <summary>
|
|
|
3552 The GetDlgItem function retrieves a handle to a control in the specified dialog box.
|
|
|
3553 </summary>
|
|
|
3554 <param name="hDlg">[in] Handle to the dialog box that contains the control. </param>
|
|
|
3555 <param name="nIDDlgItem">[in] Specifies the identifier of the control to be retrieved.</param>
|
|
|
3556 <returns>If the function succeeds, the return value is the window handle of the specified control.
|
|
|
3557 If the function fails, the return value is NULL, indicating an invalid dialog box handle or a nonexistent control. To get extended error information, call GetLastError.</returns>
|
|
|
3558 <remarks>You can use the GetDlgItem function with any parent-child window pair, not just with dialog boxes. As long as the hDlg parameter specifies a parent window and the child window has a unique identifier (as specified by the hMenu parameter in the CreateWindow or CreateWindowEx function that created the child window), GetDlgItem returns a valid handle to the child window.</remarks>
|
|
|
3559 </member>
|
|
|
3560 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetFocus">
|
|
|
3561 <summary>
|
|
|
3562 The GetFocus function retrieves the handle to the window that has the keyboard focus, if the window is attached to the calling thread's message queue.
|
|
|
3563 </summary>
|
|
|
3564 <returns>The return value is the handle to the window with the keyboard focus. If the calling thread's message queue does not have an associated window with the keyboard focus, the return value is <c>NULL</c>.</returns>
|
|
|
3565 </member>
|
|
|
3566 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetForegroundWindow">
|
|
|
3567 <summary>
|
|
|
3568 The GetForegroundWindow function returns a handle to the foreground window (the window with which the user is currently working). The system assigns a slightly higher priority to the thread that creates the foreground window than it does to other threads.
|
|
|
3569 </summary>
|
|
|
3570 <returns>The return value is a handle to the foreground window. The foreground window can be NULL in certain circumstances, such as when a window is losing activation. </returns>
|
|
|
3571 </member>
|
|
|
3572 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetGUIThreadInfo(System.UInt32,JetBrains.Interop.WinApi.GUITHREADINFO*)">
|
|
|
3573 <summary>
|
|
|
3574 Retrieves information about the active window or a specified graphical user interface (GUI) thread.
|
|
|
3575 </summary>
|
|
|
3576 <param name="idThread">Identifies the thread for which information is to be retrieved. To retrieve this value, use the GetWindowThreadProcessId function. If this parameter is NULL, the function returns information for the foreground thread.</param>
|
|
|
3577 <param name="lpgui">Pointer to a <see cref="T:JetBrains.Interop.WinApi.GUITHREADINFO"/> structure that receives information describing the thread. Note that you must set <c>GUITHREADINFO.cbSize</c> to <c>sizeof(GUITHREADINFO)</c> before calling this function.</param>
|
|
|
3578 <returns>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.</returns>
|
|
|
3579 <remarks>
|
|
|
3580 This function succeeds even if the active window is not owned by the calling process. If the specified thread does not exist or have an input queue, the function will fail.
|
|
|
3581 This function is useful for retrieving out-of-context information about a thread. The information retrieved is the same as if an application retrieved the information about itself.
|
|
|
3582 </remarks>
|
|
|
3583 </member>
|
|
|
3584 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetKeyState(System.Int32)">
|
|
|
3585 <summary>
|
|
|
3586 The GetKeyState function retrieves the status of the specified virtual key. The status specifies whether the key is up, down, or toggled (on, off—alternating each time the key is pressed).
|
|
|
3587 </summary>
|
|
|
3588 <param name="nVirtKey">
|
|
|
3589 [in] Specifies a virtual key. If the desired virtual key is a letter or digit (A through Z, a through z, or 0 through 9), nVirtKey must be set to the ASCII value of that character. For other keys, it must be a virtual-key code.
|
|
|
3590 If a non-English keyboard layout is used, virtual keys with values in the range ASCII A through Z and 0 through 9 are used to specify most of the character keys. For example, for the German keyboard layout, the virtual key of value ASCII O (0x4F) refers to the "o" key, whereas VK_OEM_1 refers to the "o with umlaut" key.
|
|
|
3591 </param>
|
|
|
3592 <returns>
|
|
|
3593 The return value specifies the status of the specified virtual key, as follows:
|
|
|
3594 • If the high-order bit is 1, the key is down; otherwise, it is up.
|
|
|
3595 • If the low-order bit is 1, the key is toggled. A key, such as the CAPS LOCK key, is toggled if it is turned on. The key is off and untoggled if the low-order bit is 0. A toggle key's indicator light (if any) on the keyboard will be on when the key is toggled, and off when the key is untoggled.
|
|
|
3596 </returns>
|
|
|
3597 </member>
|
|
|
3598 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetMessageW(JetBrains.Interop.WinApi.MSG*,System.Void*,System.UInt32,System.UInt32)">
|
|
|
3599 <summary>
|
|
|
3600 The GetMessage function retrieves a message from the calling thread's message queue. The function dispatches incoming sent messages until a posted message is available for retrieval. Unlike GetMessage, the <see cref="M:JetBrains.Interop.WinApi.User32Dll.PeekMessageW(JetBrains.Interop.WinApi.MSG*,System.Void*,System.UInt32,System.UInt32,System.UInt32)"/> function does not wait for a message to be posted before returning.
|
|
|
3601 </summary>
|
|
|
3602 <param name="lpMsg">[out] Pointer to an MSG structure that receives message information from the thread's message queue.</param>
|
|
|
3603 <param name="hWnd">[in] Handle to the window whose messages are to be retrieved. The window must belong to the current thread. If hWnd is NULL, GetMessage retrieves messages for any window that belongs to the current thread, and any messages on the current thread's message queue whose hwnd value is NULL (see the MSG structure). Therefore if hWnd is NULL, both window messages and thread messages are processed. If hWnd is -1, GetMessage retrieves only messages on the current thread's message queue whose hwnd value is NULL, that is, thread messages as posted by PostMessage (when the hWnd parameter is NULL) or PostThreadMessage.</param>
|
|
|
3604 <param name="wMsgFilterMin">[in] Specifies the integer value of the lowest message value to be retrieved. Use WM_KEYFIRST to specify the first keyboard message or WM_MOUSEFIRST to specify the first mouse message. Windows XP: Use WM_INPUT here and in wMsgFilterMax to specify only the WM_INPUT messages. If wMsgFilterMin and wMsgFilterMax are both zero, GetMessage returns all available messages (that is, no range filtering is performed).</param>
|
|
|
3605 <param name="wMsgFilterMax">[in] Specifies the integer value of the highest message value to be retrieved. Use WM_KEYLAST to specify the last keyboard message or WM_MOUSELAST to specify the last mouse message. Windows XP: Use WM_INPUT here and in wMsgFilterMin to specify only the WM_INPUT messages. If wMsgFilterMin and wMsgFilterMax are both zero, GetMessage returns all available messages (that is, no range filtering is performed).</param>
|
|
|
3606 <returns>If the function retrieves a message other than WM_QUIT, the return value is nonzero. If the function retrieves the WM_QUIT message, the return value is zero. If there is an error, the return value is -1. For example, the function fails if hWnd is an invalid window handle or lpMsg is an invalid pointer. To get extended error information, call GetLastError.</returns>
|
|
|
3607 </member>
|
|
|
3608 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetParent(System.Void*)">
|
|
|
3609 <summary>
|
|
|
3610 The GetParent function retrieves a handle to the specified window's parent or owner. To retrieve a handle to a specified ancestor, use the GetAncestor function.
|
|
|
3611 </summary>
|
|
|
3612 <param name="hWnd">[in] Handle to the window whose parent window handle is to be retrieved. </param>
|
|
|
3613 <returns>If the window is a child window, the return value is a handle to the parent window. If the window is a top-level window, the return value is a handle to the owner window. If the window is a top-level unowned window or if the function fails, the return value is NULL. To get extended error information, call GetLastError. For example, this would determine, when the function returns NULL, if the function failed or the window was a top-level window.</returns>
|
|
|
3614 <remarks>Note that, despite its name, this function can return an owner window instead of a parent window. To obtain the parent window and not the owner, use GetAncestor with the GA_PARENT flag.</remarks>
|
|
|
3615 </member>
|
|
|
3616 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetSystemMetrics(System.Int32)">
|
|
|
3617 <summary>
|
|
|
3618 Retrieves the specified system metric or system configuration setting.
|
|
|
3619 </summary>
|
|
|
3620 </member>
|
|
|
3621 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetThreadDesktop(System.UInt32)">
|
|
|
3622 <summary>
|
|
|
3623 Retrieves a handle to the desktop assigned to the specified thread. Windows Me/98/95: The system does not support multiple desktops, so GetThreadDesktop always returns the same value.
|
|
|
3624 </summary>
|
|
|
3625 <param name="dwThreadId">A handle to the thread. The GetCurrentThreadId and CreateProcess functions return thread identifiers.</param>
|
|
|
3626 <returns>If the function succeeds, the return value is a handle to the desktop associated with the specified thread. You do not need to call the CloseDesktop function to close the returned handle. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3627 </member>
|
|
|
3628 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetWindowLongPtrW(System.Void*,System.Int32)">
|
|
|
3629 <summary>
|
|
|
3630 The GetWindowLongPtrW function retrieves information about the specified window. The function also retrieves the value at a specified offset into the extra window memory.
|
|
|
3631 </summary>
|
|
|
3632 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
3633 </member>
|
|
|
3634 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetWindowRect(System.Void*,JetBrains.Interop.WinApi.RECT*)">
|
|
|
3635 <summary>
|
|
|
3636 The <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetWindowRect(System.Void*,JetBrains.Interop.WinApi.RECT*)"/> function retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
|
|
|
3637 </summary>
|
|
|
3638 </member>
|
|
|
3639 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetWindowTextW(System.Void*,System.Char*,System.Int32)">
|
|
|
3640 <summary>
|
|
|
3641 The GetWindowText function copies the text of the specified window's title bar (if it has one) into a buffer. If the specified window is a control, the text of the control is copied. However, GetWindowText cannot retrieve the text of a control in another application.
|
|
|
3642 </summary>
|
|
|
3643 <param name="hWnd">[in] Handle to the window or control containing the text. </param>
|
|
|
3644 <param name="lpString">[out] Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character</param>
|
|
|
3645 <param name="nMaxCount">[in] Specifies the maximum number of characters to copy to the buffer, including the NULL character. If the text exceeds this limit, it is truncated.</param>
|
|
|
3646 <returns>If the function succeeds, the return value is the length, in characters, of the copied string, not including the terminating NULL character. If the window has no title bar or text, if the title bar is empty, or if the window or control handle is invalid, the return value is zero. To get extended error information, call GetLastError. This function cannot retrieve the text of an edit control in another application.</returns>
|
|
|
3647 </member>
|
|
|
3648 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetWindowThreadProcessId(System.Void*,System.UInt32*)">
|
|
|
3649 <summary>
|
|
|
3650 The GetWindowThreadProcessId function retrieves the identifier of the thread that created the specified window and, optionally, the identifier of the process that created the window.
|
|
|
3651 </summary>
|
|
|
3652 <param name="hWnd">[in] Handle to the window. </param>
|
|
|
3653 <param name="lpdwProcessId">[out] Pointer to a variable that receives the process identifier. If this parameter is not NULL, GetWindowThreadProcessId copies the identifier of the process to the variable; otherwise, it does not. </param>
|
|
|
3654 <returns>The return value is the identifier of the thread that created the window. </returns>
|
|
|
3655 </member>
|
|
|
3656 <member name="M:JetBrains.Interop.WinApi.User32Dll.InvalidateRect(System.Void*,JetBrains.Interop.WinApi.RECT*,System.Int32)">
|
|
|
3657 <summary>
|
|
|
3658 The InvalidateRect function adds a rectangle to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn.
|
|
|
3659 </summary>
|
|
|
3660 </member>
|
|
|
3661 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsChild(System.Void*,System.Void*)">
|
|
|
3662 <summary>
|
|
|
3663 The IsChild function tests whether a window is a child window or descendant window of a specified parent window. A child window is the direct descendant of a specified parent window if that parent window is in the chain of parent windows; the chain of parent windows leads from the original overlapped or pop-up window to the child window.
|
|
|
3664 </summary>
|
|
|
3665 <param name="hWndParent">[in] Handle to the parent window. </param>
|
|
|
3666 <param name="hWnd">[in] Handle to the window to be tested. </param>
|
|
|
3667 <returns>If the window is a child or descendant window of the specified parent window, the return value is nonzero. If the window is not a child or descendant window of the specified parent window, the return value is zero.</returns>
|
|
|
3668 </member>
|
|
|
3669 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsIconic(System.Void*)">
|
|
|
3670 <summary>
|
|
|
3671 The IsIconic function return true is windows is minimized.
|
|
|
3672 </summary>
|
|
|
3673 </member>
|
|
|
3674 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsWindow(System.Void*)">
|
|
|
3675 <summary>
|
|
|
3676 The IsWindow function determines whether the specified window handle identifies an existing window.
|
|
|
3677 </summary>
|
|
|
3678 <param name="hWnd">[in] Handle to the window to test.</param>
|
|
|
3679 <returns>If the window handle identifies an existing window, the return value is nonzero. If the window handle does not identify an existing window, the return value is zero.</returns>
|
|
|
3680 </member>
|
|
|
3681 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsWindowEnabled(System.Void*)">
|
|
|
3682 <summary>
|
|
|
3683 The IsWindowEnabled function determines whether the specified window is enabled for mouse and keyboard input.
|
|
|
3684 </summary>
|
|
|
3685 <param name="hWnd">[in] Handle to the window to test.</param>
|
|
|
3686 <returns>If the window is enabled, the return value is nonzero. If the window is not enabled, the return value is zero.</returns>
|
|
|
3687 <remarks>A child window receives input only if it is both enabled and visible.</remarks>
|
|
|
3688 </member>
|
|
|
3689 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsWindowVisible(System.Void*)">
|
|
|
3690 <summary>
|
|
|
3691 The IsWindowVisible function retrieves the visibility state of the specified window.
|
|
|
3692 </summary>
|
|
|
3693 <param name="hWnd">[in] Handle to the window to test.</param>
|
|
|
3694 <returns>If the specified window, its parent window, its parent's parent window, and so forth, have the WS_VISIBLE style, the return value is nonzero. Otherwise, the return value is zero. Because the return value specifies whether the window has the WS_VISIBLE style, it may be nonzero even if the window is totally obscured by other windows.</returns>
|
|
|
3695 </member>
|
|
|
3696 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsZoomed(System.Void*)">
|
|
|
3697 <summary>
|
|
|
3698 The IsZoomed function return true is windows is maximized.
|
|
|
3699 </summary>
|
|
|
3700 </member>
|
|
|
3701 <member name="M:JetBrains.Interop.WinApi.User32Dll.IsWindowUnicode(System.Void*)">
|
|
|
3702 <summary>
|
|
|
3703 Determines whether the specified window is a native Unicode window.
|
|
|
3704 </summary>
|
|
|
3705 <param name="hWnd">[in] Handle to the window to be tested.</param>
|
|
|
3706 <returns>If the window is a native Unicode window, the return value is nonzero. If the window is not a native Unicode window, the return value is zero. The window is a native ANSI window..</returns>
|
|
|
3707 <remarks>
|
|
|
3708 The character set of a window is determined by the use of the RegisterClass function.
|
|
|
3709 If the window class was registered with the ANSI version of RegisterClass (RegisterClassA), the character set of the window is ANSI.
|
|
|
3710 If the window class was registered with the Unicode version of RegisterClass (RegisterClassW), the character set of the window is Unicode.
|
|
|
3711
|
|
|
3712 The system does automatic two-way translation (Unicode to ANSI) for window messages.
|
|
|
3713 For example, if an ANSI window message is sent to a window that uses the Unicode character set, the system translates that message into a Unicode message before calling the window procedure.
|
|
|
3714 The system calls IsWindowUnicode to determine whether to translate the message.
|
|
|
3715 </remarks>
|
|
|
3716 </member>
|
|
|
3717 <member name="M:JetBrains.Interop.WinApi.User32Dll.LoadCursorW(System.Void*,System.Char*)">
|
|
|
3718 <summary>
|
|
|
3719 The LoadCursor function loads the specified cursor resource from the executable (.EXE) file associated with an application instance.
|
|
|
3720 </summary>
|
|
|
3721 <param name="hInstance">[in] Handle to an instance of the module whose executable file contains the cursor to be loaded.</param>
|
|
|
3722 <param name="lpCursorName">[in] Pointer to a null-terminated string that contains the name of the cursor resource to be loaded. Alternatively, this parameter can consist of the resource identifier in the low-order word and zero in the high-order word. The MAKEINTRESOURCE macro can also be used to create this value. To use one of the predefined cursors, the application must set the hInstance parameter to NULL and the lpCursorName parameter to one the following values: <see cref="T:JetBrains.Interop.WinApi.StockCursors"/></param>
|
|
|
3723 <returns>If the function succeeds, the return value is the handle to the newly loaded cursor.
|
|
|
3724 If the function fails, the return value is NULL. To get extended error information, call GetLastError. </returns>
|
|
|
3725 </member>
|
|
|
3726 <member name="M:JetBrains.Interop.WinApi.User32Dll.LoadStringW(System.Void*,System.UInt32,System.UInt16*,System.Int32)">
|
|
|
3727 <summary>
|
|
|
3728 The LoadString function loads a string resource from the executable file associated with a specified module, copies the string into a buffer, and appends a terminating NULL character.
|
|
|
3729 </summary>
|
|
|
3730 </member>
|
|
|
3731 <member name="M:JetBrains.Interop.WinApi.User32Dll.MapWindowPoints(System.Void*,System.Void*,JetBrains.Interop.WinApi.POINT*,System.UInt32)">
|
|
|
3732 <summary>
|
|
|
3733 The MapWindowPoints function converts (maps) a set of points from a coordinate space relative to one window to a coordinate space relative to another window.
|
|
|
3734 </summary>
|
|
|
3735 <param name="hWndFrom">[in] Handle to the window from which points are converted. If this parameter is NULL or HWND_DESKTOP, the points are presumed to be in screen coordinates. </param>
|
|
|
3736 <param name="hWndTo">[in] Handle to the window to which points are converted. If this parameter is NULL or HWND_DESKTOP, the points are converted to screen coordinates. </param>
|
|
|
3737 <param name="lpPoints">[in/out] Pointer to an array of POINT structures that contain the set of points to be converted. The points are in device units. This parameter can also point to a RECT structure, in which case the cPoints parameter should be set to 2. </param>
|
|
|
3738 <param name="cPoints">[in] Specifies the number of POINT structures in the array pointed to by the lpPoints parameter. </param>
|
|
|
3739 <returns>If the function succeeds, the low-order word of the return value is the number of pixels added to the horizontal coordinate of each source point in order to compute the horizontal coordinate of each destination point; the high-order word is the number of pixels added to the vertical coordinate of each source point in order to compute the vertical coordinate of each destination point. If the function fails, the return value is zero. Call SetLastError prior to calling this method to differentiate an error return value from a legitimate "0" return value. Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
3740 <remarks>If hWndFrom or hWndTo (or both) are mirrored windows (that is, have WS_EX_LAYOUTRTL extended style), MapWindowPoints will automatically adjust mirrored coordinates if you pass two or less points in lpPoints. If you pass more than two points, the function will not fail but it will return erroneous positions. Thus, to guarantee the correct transformation of rectangle coordinates, you must call MapWindowPoints with two or less points at a time, as shown in the following example:
|
|
|
3741 <code>
|
|
|
3742 RECT rc[10];
|
|
|
3743
|
|
|
3744 for(int i =0; i < (sizeof(rc)/sizeof(rc[0])); i++)
|
|
|
3745 {
|
|
|
3746 MapWindowPoints(hWnd1, hWnd2, (LPPOINT)(&rc[i]), (sizeof(RECT)/sizeof(POINT)) );
|
|
|
3747 }
|
|
|
3748 </code></remarks>
|
|
|
3749 </member>
|
|
|
3750 <member name="M:JetBrains.Interop.WinApi.User32Dll.MessageBoxW(System.Void*,System.String,System.String,System.UInt32)">
|
|
|
3751 <summary>
|
|
|
3752 The MessageBox function creates, displays, and operates a message box. The message box contains an application-defined message and title, along with any combination of predefined icons and push buttons.
|
|
|
3753 </summary>
|
|
|
3754 </member>
|
|
|
3755 <member name="M:JetBrains.Interop.WinApi.User32Dll.MsgWaitForMultipleObjects(System.UInt32,System.Void**,System.Int32,System.UInt32,System.UInt32)">
|
|
|
3756 <summary>
|
|
|
3757 Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses. The objects can include input event objects, which you specify using the dwWakeMask parameter. To enter an alertable wait state, use the <see cref="M:JetBrains.Interop.WinApi.User32Dll.MsgWaitForMultipleObjectsEx(System.UInt32,System.Void**,System.UInt32,System.UInt32,System.UInt32)"/> function.
|
|
|
3758 </summary>
|
|
|
3759 </member>
|
|
|
3760 <member name="M:JetBrains.Interop.WinApi.User32Dll.MsgWaitForMultipleObjectsEx(System.UInt32,System.Void**,System.UInt32,System.UInt32,System.UInt32)">
|
|
|
3761 <summary>
|
|
|
3762 Waits until one or all of the specified objects are in the signaled state, an I/O completion routine or asynchronous procedure call (APC) is queued to the thread, or the time-out interval elapses. The array of objects can include input event objects, which you specify using the dwWakeMask parameter.
|
|
|
3763 </summary>
|
|
|
3764 </member>
|
|
|
3765 <member name="M:JetBrains.Interop.WinApi.User32Dll.OpenDesktopW(System.String,System.UInt32,System.Int32,System.UInt32)">
|
|
|
3766 <summary>
|
|
|
3767 Opens the specified desktop object.
|
|
|
3768 </summary>
|
|
|
3769 <param name="lpszDesktop">The name of the desktop to be opened. Desktop names are case-insensitive. This desktop must belong to the current window station.</param>
|
|
|
3770 <param name="dwFlags">This parameter can be zero or the following value. <c>DF_ALLOWOTHERACCOUNTHOOK</c> <c>0x0001</c> Allows processes running in other accounts on the desktop to set hooks in this process.</param>
|
|
|
3771 <param name="fInherit">If this value is TRUE, processes created by this process will inherit the handle. Otherwise, the processes do not inherit this handle.</param>
|
|
|
3772 <param name="dwDesiredAccess">The access to the desktop. For a list of access rights, see Desktop Security and Access Rights.</param>
|
|
|
3773 <returns>If the function succeeds, the return value is a handle to the opened desktop. When you are finished using the handle, call the CloseDesktop function to close it. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3774 </member>
|
|
|
3775 <member name="M:JetBrains.Interop.WinApi.User32Dll.OpenWindowStationW(System.String,System.Int32,System.UInt32)">
|
|
|
3776 <summary>
|
|
|
3777 Opens the specified window station.
|
|
|
3778 </summary>
|
|
|
3779 <param name="lpszWinSta">The name of the window station to be opened. Window station names are case-insensitive. This window station must belong to the current session.</param>
|
|
|
3780 <param name="fInherit">If this value is TRUE, processes created by this process will inherit the handle. Otherwise, the processes do not inherit this handle.</param>
|
|
|
3781 <param name="dwDesiredAccess">The access to the window station. For a list of access rights, see Window Station Security and Access Rights.</param>
|
|
|
3782 <returns>If the function succeeds, the return value is the handle to the specified window station. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3783 </member>
|
|
|
3784 <member name="M:JetBrains.Interop.WinApi.User32Dll.PeekMessageW(JetBrains.Interop.WinApi.MSG*,System.Void*,System.UInt32,System.UInt32,System.UInt32)">
|
|
|
3785 <summary>
|
|
|
3786 The PeekMessage function dispatches incoming sent messages, checks the thread message queue for a posted message, and retrieves the message (if any exist).
|
|
|
3787 </summary>
|
|
|
3788 <param name="lpMsg">[out] Pointer to an MSG structure that receives message information.</param>
|
|
|
3789 <param name="hWnd">[in] Handle to the window whose messages are to be retrieved. The window must belong to the current thread.
|
|
|
3790 If hWnd is NULL, PeekMessage retrieves messages for any window that belongs to the current thread, and any messages on the current thread's message queue whose hwnd value is NULL (see the MSG structure). Therefore if hWnd is NULL, both window messages and thread messages are processed.
|
|
|
3791 If hWnd is -1, PeekMessage retrieves only messages on the current thread's message queue whose hwnd value is NULL, that is, thread messages as posted by PostMessage (when the hWnd parameter is NULL) or PostThreadMessage.
|
|
|
3792 </param>
|
|
|
3793 <param name="wMsgFilterMin">[in] Specifies the value of the first message in the range of messages to be examined. Use WM_KEYFIRST to specify the first keyboard message or WM_MOUSEFIRST to specify the first mouse message. If wMsgFilterMin and wMsgFilterMax are both zero, PeekMessage returns all available messages (that is, no range filtering is performed).</param>
|
|
|
3794 <param name="wMsgFilterMax">[in] Specifies the value of the last message in the range of messages to be examined. Use WM_KEYLAST to specify the last keyboard message or WM_MOUSELAST to specify the last mouse message. If wMsgFilterMin and wMsgFilterMax are both zero, PeekMessage returns all available messages (that is, no range filtering is performed).</param>
|
|
|
3795 <param name="wRemoveMsg">[in] Specifies how messages are handled. This parameter can be one of the following values. PM_NOREMOVE Messages are not removed from the queue after processing by PeekMessage. PM_REMOVE Messages are removed from the queue after processing by PeekMessage. You can optionally combine the value PM_NOYIELD with either PM_NOREMOVE or PM_REMOVE. This flag prevents the system from releasing any thread that is waiting for the caller to go idle (see WaitForInputIdle). By default, all message types are processed. To specify that only certain message should be processed, specify one or more of the following values. PM_QS_INPUT Windows 98/Me, Windows 2000/XP: Process mouse and keyboard messages. PM_QS_PAINT Windows 98/Me, Windows 2000/XP: Process paint messages. PM_QS_POSTMESSAGE Windows 98/Me, Windows 2000/XP: Process all posted messages, including timers and hotkeys. PM_QS_SENDMESSAGE Windows 98/Me, Windows 2000/XP: Process all sent messages.</param>
|
|
|
3796 <returns>If a message is available, the return value is nonzero. If no messages are available, the return value is zero.</returns>
|
|
|
3797 </member>
|
|
|
3798 <member name="M:JetBrains.Interop.WinApi.User32Dll.PostMessageW(System.Void*,System.UInt32,System.IntPtr,System.IntPtr)">
|
|
|
3799 <summary>
|
|
|
3800 The PostMessageW function places (posts) a message in the message queue associated with the thread that created the specified window and returns without waiting for the thread to process the message. To post a message in the message queue associate with a thread, use the PostThreadMessage function.
|
|
|
3801 </summary>
|
|
|
3802 </member>
|
|
|
3803 <member name="M:JetBrains.Interop.WinApi.User32Dll.PostThreadMessageW(System.UInt32,System.UInt32,System.IntPtr,System.IntPtr)">
|
|
|
3804 <summary>
|
|
|
3805 The PostThreadMessage function posts a message to the message queue of the specified thread. It returns without waiting for the thread to process the message.
|
|
|
3806 </summary>
|
|
|
3807 </member>
|
|
|
3808 <member name="M:JetBrains.Interop.WinApi.User32Dll.PostQuitMessage(System.Int32)">
|
|
|
3809 <summary>
|
|
|
3810 Indicates to the system that a thread has made a request to terminate (quit). It is typically used in response to a WM_DESTROY message.
|
|
|
3811 </summary>
|
|
|
3812 <param name="exitCode">[in] The application exit code. This value is used as the wParam parameter of the WM_QUIT message.</param>
|
|
|
3813 <returns>This function does not return a value.</returns>
|
|
|
3814 </member>
|
|
|
3815 <member name="M:JetBrains.Interop.WinApi.User32Dll.WaitMessage">
|
|
|
3816 <summary>
|
|
|
3817 Yields control to other threads when a thread has no other messages in its message queue.
|
|
|
3818 The WaitMessage function suspends the thread and does not return until a new message is placed in the thread's message queue.
|
|
|
3819 </summary>
|
|
|
3820 <returns>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.</returns>
|
|
|
3821 </member>
|
|
|
3822 <member name="M:JetBrains.Interop.WinApi.User32Dll.PrintWindow(System.Void*,System.Void*,System.UInt32)">
|
|
|
3823 <summary>
|
|
|
3824 The PrintWindow function copies a visual window into the specified device context (DC), typically a printer DC.
|
|
|
3825 </summary>
|
|
|
3826 <param name="hwnd">Window to copy</param>
|
|
|
3827 <param name="hdcBlt">HDC to print into</param>
|
|
|
3828 <param name="nFlags">Optional flags</param>
|
|
|
3829 <returns>If the function succeeds, it returns a nonzero value.
|
|
|
3830 If the function fails, it returns zero.</returns>
|
|
|
3831 </member>
|
|
|
3832 <member name="M:JetBrains.Interop.WinApi.User32Dll.ScreenToClient(System.Void*,JetBrains.Interop.WinApi.POINT*)">
|
|
|
3833 <summary>
|
|
|
3834 The ScreenToClient function converts the screen coordinates of a specified point on the screen to client-area coordinates.
|
|
|
3835 </summary>
|
|
|
3836 <param name="hWnd">[in] Handle to the window whose client area will be used for the conversion. </param>
|
|
|
3837 <param name="lpPoint">[in] Pointer to a POINT structure that specifies the screen coordinates to be converted. </param>
|
|
|
3838 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
3839 </member>
|
|
|
3840 <member name="M:JetBrains.Interop.WinApi.User32Dll.SendMessageW(System.Void*,System.UInt32,System.IntPtr,System.IntPtr)">
|
|
|
3841 <summary>
|
|
|
3842 The SendMessage function sends the specified message to a window or windows. It calls the window procedure for the specified window and does not return until the window procedure has processed the message.
|
|
|
3843 To send a message and return immediately, use the SendMessageCallback or SendNotifyMessage function. To post a message to a thread's message queue and return immediately, use the PostMessageW or PostThreadMessage function.
|
|
|
3844 </summary>
|
|
|
3845 </member>
|
|
|
3846 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetActiveWindow(System.Void*)">
|
|
|
3847 <summary>
|
|
|
3848 The SetActiveWindow function activates a window. The window must be attached to the calling thread's message queue.
|
|
|
3849 </summary>
|
|
|
3850 <param name="hWnd">[in] Handle to the top-level window to be activated.</param>
|
|
|
3851 <returns>If the function succeeds, the return value is the handle to the window that was previously active. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3852 <remarks>
|
|
|
3853 <para>The SetActiveWindow function activates a window, but not if the application is in the background. The window will be brought into the foreground (top of Z-Order) if its application is in the foreground when the system activates the window. </para>
|
|
|
3854 <para>If the window identified by the hWnd parameter was created by the calling thread, the active window status of the calling thread is set to hWnd. Otherwise, the active window status of the calling thread is set to NULL.</para>
|
|
|
3855 <para>By using the AttachThreadInput function, a thread can attach its input processing to another thread. This allows a thread to call SetActiveWindow to activate a window attached to another thread's message queue. </para>
|
|
|
3856 </remarks>
|
|
|
3857 </member>
|
|
|
3858 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetCursor(System.Void*)">
|
|
|
3859 <summary>
|
|
|
3860 The SetCursor function sets the cursor shape.
|
|
|
3861 </summary>
|
|
|
3862 <param name="hCursor">
|
|
|
3863 [in]
|
|
|
3864 Handle to the cursor. The cursor must have been created by the CreateCursor function or loaded by the LoadCursor or LoadImage function. If this parameter is NULL, the cursor is removed from the screen.
|
|
|
3865 Windows 95/98/Me: The width and height of the cursor must be the values returned by the GetSystemMetrics function for SM_CXCURSOR and SM_CYCURSOR. For Microsoft Windows 95, either the cursor bit depth must match the bit depth of the display or the cursor must be monochrome. However, for Windows 98 and Windows 98, if the cursor bit depth does not match the bit depth of the display then the cursor is converted to 4bpp VGA color.
|
|
|
3866 </param>
|
|
|
3867 <returns>
|
|
|
3868 The return value is the handle to the previous cursor, if there was one.
|
|
|
3869 If there was no previous cursor, the return value is NULL.
|
|
|
3870 </returns>
|
|
|
3871 </member>
|
|
|
3872 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetFocus(System.Void*)">
|
|
|
3873 <summary>
|
|
|
3874 The SetFocus function sets the keyboard focus to the specified window. The window must be attached to the calling thread's message queue. The SetFocus function sends a WM_KILLFOCUS message to the window that loses the keyboard focus and a WM_SETFOCUS message to the window that receives the keyboard focus. It also activates either the window that receives the focus or the parent of the window that receives the focus. If a window is active but does not have the focus, any key pressed will produce the WM_SYSCHAR, WM_SYSKEYDOWN, or WM_SYSKEYUP message. If the VK_MENU key is also pressed, the lParam parameter of the message will have bit 30 set. Otherwise, the messages produced do not have this bit set. By using the AttachThreadInput function, a thread can attach its input processing to another thread. This allows a thread to call SetFocus to set the keyboard focus to a window attached to another thread's message queue.
|
|
|
3875 </summary>
|
|
|
3876 <param name="hWnd">[in] Handle to the window that will receive the keyboard input. If this parameter is NULL, keystrokes are ignored. </param>
|
|
|
3877 <returns>If the function succeeds, the return value is the handle to the window that previously had the keyboard focus. If the hWnd parameter is invalid or the window is not attached to the calling thread's message queue, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
3878 </member>
|
|
|
3879 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetForegroundWindow(System.Void*)">
|
|
|
3880 <summary>
|
|
|
3881 The SetForegroundWindow function puts the thread that created the specified window into the foreground and
|
|
|
3882 activates the window. Keyboard input is directed to the window, and various visual cues are changed for the user.
|
|
|
3883 The system assigns a slightly higher priority to the thread that created the foreground window than it does to other threads.
|
|
|
3884 </summary>
|
|
|
3885 </member>
|
|
|
3886 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetLayeredWindowAttributes(System.Void*,System.UInt32,System.Byte,System.UInt32)">
|
|
|
3887 <summary>
|
|
|
3888 The SetLayeredWindowAttributes function sets the opacity and transparency color key of a layered window.
|
|
|
3889 </summary>
|
|
|
3890 </member>
|
|
|
3891 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetParent(System.Void*,System.Void*)">
|
|
|
3892 <summary>
|
|
|
3893 The SetParent function changes the parent window of the specified child window.
|
|
|
3894 An application can use the SetParent function to set the parent window of a pop-up, overlapped, or child window. The new parent window and the child window must belong to the same application. If the window identified by the hWndChild parameter is visible, the system performs the appropriate redrawing and repainting. For compatibility reasons, SetParent does not modify the WS_CHILD or WS_POPUP window styles of the window whose parent is being changed. Therefore, if hWndNewParent is NULL, you should also clear the WS_CHILD bit and set the WS_POPUP style after calling SetParent. Conversely, if hWndNewParent is not NULL and the window was previously a child of the desktop, you should clear the WS_POPUP style and set the WS_CHILD style before calling SetParent. Windows 2000/XP: When you change the parent of a window, you should synchronize the UISTATE of both windows. For more information, see WM_CHANGEUISTATE and WM_UPDATEUISTATE.
|
|
|
3895 </summary>
|
|
|
3896 <param name="hWndChild">[in] Handle to the child window.</param>
|
|
|
3897 <param name="hWndNewParent">[in] Handle to the new parent window. If this parameter is NULL, the desktop window becomes the new parent window. Windows 2000/XP: If this parameter is HWND_MESSAGE, the child window becomes a message-only window.</param>
|
|
|
3898 <returns>If the function succeeds, the return value is a handle to the previous parent window. If the function fails, the return value is NULL. To get extended error information, call GetLastError. </returns>
|
|
|
3899 </member>
|
|
|
3900 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetProcessWindowStation(System.Void*)">
|
|
|
3901 <summary>
|
|
|
3902 Assigns the specified window station to the calling process. This enables the process to access objects in the window station such as desktops, the clipboard, and global atoms. All subsequent operations on the window station use the access rights granted to hWinSta.
|
|
|
3903 </summary>
|
|
|
3904 <param name="hWinSta">A handle to the window station. This can be a handle returned by the CreateWindowStation, OpenWindowStation, or GetProcessWindowStation function. This window station must be associated with the current session.</param>
|
|
|
3905 <returns>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.</returns>
|
|
|
3906 </member>
|
|
|
3907 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetThreadDesktop(System.Void*)">
|
|
|
3908 <summary>
|
|
|
3909 Assigns the specified desktop to the calling thread. All subsequent operations on the desktop use the access rights granted to the desktop.
|
|
|
3910 </summary>
|
|
|
3911 <param name="hDesktop">A handle to the desktop to be assigned to the calling thread. This handle is returned by the CreateDesktop, GetThreadDesktop, OpenDesktop, or OpenInputDesktop function. This desktop must be associated with the current window station for the process.</param>
|
|
|
3912 <returns>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.</returns>
|
|
|
3913 </member>
|
|
|
3914 <member name="M:JetBrains.Interop.WinApi.User32Dll.SetWindowLongPtrW(System.Void*,System.Int32,System.Void*)">
|
|
|
3915 <summary>
|
|
|
3916 The SetWindowLongPtrW function changes an attribute of the specified window. The function also sets a value at the specified offset in the extra window memory.
|
|
|
3917 </summary>
|
|
|
3918 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
3919 </member>
|
|
|
3920 <member name="M:JetBrains.Interop.WinApi.User32Dll.ShowWindow(System.Void*,System.Int32)">
|
|
|
3921 <summary>
|
|
|
3922 The ShowWindow function sets the specified window's show state.
|
|
|
3923 </summary>
|
|
|
3924 </member>
|
|
|
3925 <member name="M:JetBrains.Interop.WinApi.User32Dll.SwitchToThisWindow(System.Void*,System.UInt32)">
|
|
|
3926 <summary>
|
|
|
3927 The SwitchToThisWindow function is called to switch focus to a specified window and bring it to the foreground.
|
|
|
3928 </summary>
|
|
|
3929 </member>
|
|
|
3930 <member name="M:JetBrains.Interop.WinApi.User32Dll.TranslateMessage(JetBrains.Interop.WinApi.MSG*)">
|
|
|
3931 <summary>
|
|
|
3932 The TranslateMessage function translates virtual-key messages into character messages. The character messages are posted to the calling thread's message queue, to be read the next time the thread calls the <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetMessageW(JetBrains.Interop.WinApi.MSG*,System.Void*,System.UInt32,System.UInt32)"/> or <see cref="M:JetBrains.Interop.WinApi.User32Dll.PeekMessageW(JetBrains.Interop.WinApi.MSG*,System.Void*,System.UInt32,System.UInt32,System.UInt32)"/> function.
|
|
|
3933 </summary>
|
|
|
3934 <param name="lpMsg">[in] Pointer to an <see cref="T:JetBrains.Interop.WinApi.MSG"/> structure that contains message information retrieved from the calling thread's message queue by using the GetMessage or PeekMessage function.</param>
|
|
|
3935 <returns>If the message is translated (that is, a character message is posted to the thread's message queue), the return value is nonzero. If the message is <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_KEYDOWN"/>, <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_KEYUP"/>, <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_SYSKEYDOWN"/>, or <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_SYSKEYUP"/>, the return value is nonzero, regardless of the translation. If the message is not translated (that is, a character message is not posted to the thread's message queue), the return value is zero.</returns>
|
|
|
3936 </member>
|
|
|
3937 <member name="M:JetBrains.Interop.WinApi.User32Dll.UpdateLayeredWindow(System.Void*,System.Void*,JetBrains.Interop.WinApi.POINT*,JetBrains.Interop.WinApi.Declarations.Structures.SIZE*,System.Void*,JetBrains.Interop.WinApi.POINT*,System.UInt32,JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION*,System.UInt32)">
|
|
|
3938 <summary>
|
|
|
3939 The UpdateLayeredWindow function updates the position, size, shape, content, and translucency of a layered window.
|
|
|
3940 </summary>
|
|
|
3941 <param name="hwnd">[in] Handle to a layered window. A layered window is created by specifying WS_EX_LAYERED when creating the window with the CreateWindowEx function.</param>
|
|
|
3942 <param name="hdcDst">[in]
|
|
|
3943 Handle to a device context (DC) for the screen. This handle is obtained by specifying NULL when calling the function. It is used for palette color matching when the window contents are updated. If hdcDst isNULL, the default palette will be used.
|
|
|
3944 If hdcSrc is NULL, hdcDst must be NULL.</param>
|
|
|
3945 <param name="pptDst">[in] Pointer to a POINT structure that specifies the new screen position of the layered window. If the current position is not changing, pptDst can be NULL. </param>
|
|
|
3946 <param name="psize">[in] Pointer to a SIZE structure that specifies the new size of the layered window. If the size of the window is not changing, psize can be NULL. If hdcSrc is NULL, psize must be NULL.</param>
|
|
|
3947 <param name="hdcSrc">[in] Handle to a DC for the surface that defines the layered window. This handle can be obtained by calling the CreateCompatibleDC function. If the shape and visual context of the window are not changing, hdcSrc can be NULL.</param>
|
|
|
3948 <param name="pptSrc">[in] Pointer to a POINT structure that specifies the location of the layer in the device context. If hdcSrc is NULL, pptSrc should be NULL.</param>
|
|
|
3949 <param name="crKey">[in] Pointer to a COLORREF value that specifies the color key to be used when composing the layered window. To generate a COLORREF, use the RGB macro.</param>
|
|
|
3950 <param name="pblend">[in] Pointer to a BLENDFUNCTION structure that specifies the transparency value to be used when composing the layered window.</param>
|
|
|
3951 <param name="dwFlags">[in] This parameter can be one of the following values. <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_ALPHA"/>, <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_COLORKEY"/>, <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_OPAQUE"/>. If hdcSrc is NULL, dwFlags should be zero.</param>
|
|
|
3952 <returns>If the function succeeds, the return value is nonzero.</returns>
|
|
|
3953 </member>
|
|
|
3954 <member name="M:JetBrains.Interop.WinApi.User32Dll.ValidateRect(System.Void*,JetBrains.Interop.WinApi.RECT*)">
|
|
|
3955 <summary>
|
|
|
3956 The ValidateRect function validates the client area within a rectangle by removing the rectangle from the update region of the specified window.
|
|
|
3957 </summary>
|
|
|
3958 </member>
|
|
|
3959 <member name="M:JetBrains.Interop.WinApi.User32Dll.WindowFromPoint(JetBrains.Interop.WinApi.POINT)">
|
|
|
3960 <summary>
|
|
|
3961 <para>The WindowFromPoint function retrieves a handle to the window that contains the specified point. </para>
|
|
|
3962 </summary>
|
|
|
3963 <param name="Point">[in] Specifies a POINT structure that defines the point to be checked. </param>
|
|
|
3964 <returns>The return value is a handle to the window that contains the point. If no window exists at the given point, the return value is NULL. If the point is over a static text control, the return value is a handle to the window under the static text control. </returns>
|
|
|
3965 <remarks>The WindowFromPoint function does not retrieve a handle to a hidden or disabled window, even if the point is within the window. An application should use the ChildWindowFromPoint function for a nonrestrictive search.</remarks>
|
|
|
3966 </member>
|
|
|
3967 <member name="M:JetBrains.Interop.WinApi.User32Dll.RegisterWindowMessageW(System.String)">
|
|
|
3968 <summary>
|
|
|
3969 Defines a new window message that is guaranteed to be unique throughout the system. The message value can be used when sending or posting messages.
|
|
|
3970 </summary>
|
|
|
3971 </member>
|
|
|
3972 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetDesktopWindow">
|
|
|
3973 <summary>
|
|
|
3974 Retrieves a handle to the desktop window. The desktop window covers the entire screen. The desktop window is the area on top of which other windows are painted.
|
|
|
3975 </summary>
|
|
|
3976 <returns>The return value is a handle to the desktop window.</returns>
|
|
|
3977 </member>
|
|
|
3978 <member name="M:JetBrains.Interop.WinApi.User32Dll.mouse_event(System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UIntPtr)">
|
|
|
3979 <summary>
|
|
|
3980 The mouse_event function synthesizes mouse motion and button clicks.
|
|
|
3981 </summary>
|
|
|
3982 </member>
|
|
|
3983 <member name="M:JetBrains.Interop.WinApi.User32Dll.keybd_event(System.Byte,System.Byte,System.UInt32,System.UIntPtr)">
|
|
|
3984 <summary>
|
|
|
3985 Synthesizes a keystroke. The system can use such a synthesized keystroke to generate a <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_KEYUP"/> or <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.WM_KEYDOWN"/> message. The keyboard driver's interrupt handler calls the keybd_event function.
|
|
|
3986 </summary>
|
|
|
3987 </member>
|
|
|
3988 <member name="M:JetBrains.Interop.WinApi.User32Dll.VkKeyScanW(System.Char)">
|
|
|
3989 <summary>
|
|
|
3990 <para>[This function has been superseded by the VkKeyScanEx function. You can still use VkKeyScanW, however, if you do not need to specify a keyboard layout.]</para>
|
|
|
3991 <para>Translates a character to the corresponding virtual-key code and shift state for the current keyboard.</para>
|
|
|
3992 </summary>
|
|
|
3993 </member>
|
|
|
3994 <member name="M:JetBrains.Interop.WinApi.User32Dll.GetAsyncKeyState(System.Int32)">
|
|
|
3995 <summary>
|
|
|
3996 Determines whether a key is up or down at the time the function is called, and whether the key was pressed after a previous call to GetAsyncKeyState.
|
|
|
3997 </summary>
|
|
|
3998 </member>
|
|
|
3999 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.BringWindowToTop(System.IntPtr)">
|
|
|
4000 <summary>
|
|
|
4001 The BringWindowToTop function brings the specified window to the top of the Z order. If the window is a top-level
|
|
|
4002 window, it is activated. If the window is a child window, the top-level parent window associated with the child window is activated.
|
|
|
4003 </summary>
|
|
|
4004 </member>
|
|
|
4005 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.ClientToScreen(System.IntPtr,System.Drawing.Point)">
|
|
|
4006 <summary>
|
|
|
4007 Converts a point from window coordinates to screen coordinates, returns an empty point on failure.
|
|
|
4008 </summary>
|
|
|
4009 </member>
|
|
|
4010 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.ClientToScreen(System.IntPtr,System.Drawing.Rectangle)">
|
|
|
4011 <summary>
|
|
|
4012 Converts a rectangle from window coordinates to screen coordinates, returns an empty rectangle on failure.
|
|
|
4013 </summary>
|
|
|
4014 </member>
|
|
|
4015 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.DestroyWindow(System.IntPtr)">
|
|
|
4016 <summary>
|
|
|
4017 Calls <see cref="M:JetBrains.Interop.WinApi.User32Dll.DestroyWindow(System.Void*)"/>.
|
|
|
4018 </summary>
|
|
|
4019 </member>
|
|
|
4020 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.DisableWindow(System.IntPtr)">
|
|
|
4021 <summary>
|
|
|
4022 Disables the window given by its handle.
|
|
|
4023 </summary>
|
|
|
4024 </member>
|
|
|
4025 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.EnableWindow(System.IntPtr)">
|
|
|
4026 <summary>
|
|
|
4027 Enables the window given by its handle.
|
|
|
4028 </summary>
|
|
|
4029 </member>
|
|
|
4030 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetChildWindowHandles(System.IntPtr)">
|
|
|
4031 <summary>
|
|
|
4032 Lists the handles of all child windows of a specific window, recursively.
|
|
|
4033 </summary>
|
|
|
4034 </member>
|
|
|
4035 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetClientRect(System.IntPtr)">
|
|
|
4036 <summary>
|
|
|
4037 Gets the client rectangle for the window.
|
|
|
4038 </summary>
|
|
|
4039 </member>
|
|
|
4040 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetCursorInfo">
|
|
|
4041 <summary>
|
|
|
4042 Gets the point out of the <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetCursorInfo(JetBrains.Interop.WinApi.Declarations.Structures.CURSORINFO*)"/> (note: <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetCursorPos(JetBrains.Interop.WinApi.POINT*)"/> should not be used).
|
|
|
4043 </summary>
|
|
|
4044 </member>
|
|
|
4045 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetDlgItem(System.IntPtr,System.Int32)">
|
|
|
4046 <summary>
|
|
|
4047 The GetDlgItem function retrieves a handle to a control in the specified dialog box.
|
|
|
4048 </summary>
|
|
|
4049 <param name="hDlg">[in] Handle to the dialog box that contains the control. </param>
|
|
|
4050 <param name="nDlgItem">[in] Specifies the identifier of the control to be retrieved.</param>
|
|
|
4051 <returns>If the function succeeds, the return value is the window handle of the specified control.
|
|
|
4052 If the function fails, the return value is NULL, indicating an invalid dialog box handle or a nonexistent control. To get extended error information, call GetLastError.</returns>
|
|
|
4053 <remarks>You can use the GetDlgItem function with any parent-child window pair, not just with dialog boxes. As long as the hDlg parameter specifies a parent window and the child window has a unique identifier (as specified by the hMenu parameter in the CreateWindow or CreateWindowEx function that created the child window), GetDlgItem returns a valid handle to the child window.</remarks>
|
|
|
4054 </member>
|
|
|
4055 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetFocusOnAnyThreadInAnyProcess">
|
|
|
4056 <summary>
|
|
|
4057 Gets the window that currently has focus on this desktop — any thread, any process, etc.
|
|
|
4058 </summary>
|
|
|
4059 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.GetFocus"/>
|
|
|
4060 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.GetForegroundWindow"/>
|
|
|
4061 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetFocusOnAnyThreadInOurProcess"/>
|
|
|
4062 </member>
|
|
|
4063 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetFocusOnAnyThreadInOurProcess">
|
|
|
4064 <summary>
|
|
|
4065 Gets the window that currently has focus in our process — but on any thread, unlike <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetFocus"/>.
|
|
|
4066 </summary>
|
|
|
4067 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.GetFocus"/>
|
|
|
4068 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.GetForegroundWindow"/>
|
|
|
4069 <seealso cref="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetFocusOnAnyThreadInAnyProcess"/>
|
|
|
4070 </member>
|
|
|
4071 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetFocus">
|
|
|
4072 <summary>
|
|
|
4073 The GetFocus function retrieves the handle to the window that has the keyboard focus, if the window is attached to the calling thread's message queue.
|
|
|
4074 </summary>
|
|
|
4075 <returns>The return value is the handle to the window with the keyboard focus. If the calling thread's message queue does not have an associated window with the keyboard focus, the return value is <c>NULL</c>.</returns>
|
|
|
4076 </member>
|
|
|
4077 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetParent(System.IntPtr)">
|
|
|
4078 <summary>
|
|
|
4079 Gets parent window for the window
|
|
|
4080 </summary>
|
|
|
4081 </member>
|
|
|
4082 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetThreadTopLevelWindowHandles(System.UInt32)">
|
|
|
4083 <summary>
|
|
|
4084 Lists the handles of all the top-level windows that belong to the specific thread.
|
|
|
4085 </summary>
|
|
|
4086 </member>
|
|
|
4087 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetTopLevelWindowHandles">
|
|
|
4088 <summary>
|
|
|
4089 Lists the handles of all the top-level windows currently available in the system.
|
|
|
4090 </summary>
|
|
|
4091 </member>
|
|
|
4092 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowClassName(System.IntPtr)">
|
|
|
4093 <summary>
|
|
|
4094 Wnd class name.
|
|
|
4095 </summary>
|
|
|
4096 </member>
|
|
|
4097 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowLongPtrW(System.IntPtr,JetBrains.Interop.WinApi.WindowLongPtrIndex)">
|
|
|
4098 <summary>
|
|
|
4099 NOTE: here void* is used as a return type because otherwise on 64-bit systems casting it to an int might get unsafe unexpectedly.
|
|
|
4100 </summary>
|
|
|
4101 <param name="hWnd"></param>
|
|
|
4102 <param name="nIndex"></param>
|
|
|
4103 <returns></returns>
|
|
|
4104 </member>
|
|
|
4105 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowProcessId(System.IntPtr)">
|
|
|
4106 <summary>
|
|
|
4107 Gets the ID of the process that owns the window.
|
|
|
4108 Note that creating a <see cref="T:System.Diagnostics.Process"/> wrapper for that is very expensive because it causes an enumeration of all the system processes to happen.
|
|
|
4109 </summary>
|
|
|
4110 </member>
|
|
|
4111 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowRect(System.IntPtr)">
|
|
|
4112 <summary>
|
|
|
4113 Wraps <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetWindowRect(System.Void*,JetBrains.Interop.WinApi.RECT*)"/>.
|
|
|
4114 </summary>
|
|
|
4115 </member>
|
|
|
4116 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowText(System.IntPtr)">
|
|
|
4117 <summary>
|
|
|
4118 Wnd text.
|
|
|
4119 </summary>
|
|
|
4120 </member>
|
|
|
4121 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.GetWindowThreadId(System.IntPtr)">
|
|
|
4122 <summary>
|
|
|
4123 Gets the ID of the thread that owns the window.
|
|
|
4124 </summary>
|
|
|
4125 </member>
|
|
|
4126 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.InvalidateRect(System.IntPtr,System.Nullable{System.Drawing.Rectangle},System.Boolean)">
|
|
|
4127 <summary>
|
|
|
4128 Invalidates the specific rectangle. If <paramref name="rect"/> is <c>Null</c>, the whole window is invalidated.
|
|
|
4129 </summary>
|
|
|
4130 </member>
|
|
|
4131 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsIconic(System.IntPtr)">
|
|
|
4132 <summary>
|
|
|
4133 The IsIconic function return true is windows is minimized.
|
|
|
4134 </summary>
|
|
|
4135 </member>
|
|
|
4136 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsThreadWithMessageQueue(System.UInt32)">
|
|
|
4137 <summary>
|
|
|
4138 Gets whether the given thread has a message pump created for it.
|
|
|
4139 </summary>
|
|
|
4140 </member>
|
|
|
4141 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsWindow(System.IntPtr)">
|
|
|
4142 <summary>
|
|
|
4143 The IsWindow function determines whether the specified window handle identifies an existing window.
|
|
|
4144 </summary>
|
|
|
4145 <param name="handle">[in] Handle to the window to test.</param>
|
|
|
4146 <returns>If the window handle identifies an existing window, the return value is nonzero. If the window handle does not identify an existing window, the return value is zero.</returns>
|
|
|
4147 </member>
|
|
|
4148 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsWindowEnabled(System.IntPtr)">
|
|
|
4149 <summary>
|
|
|
4150 The IsWindowEnabled function determines whether the specified window is enabled for mouse and keyboard input.
|
|
|
4151 </summary>
|
|
|
4152 <param name="handle">[in] Handle to the window to test.</param>
|
|
|
4153 <returns>If the window is enabled, the return value is nonzero. If the window is not enabled, the return value is zero.</returns>
|
|
|
4154 <remarks>A child window receives input only if it is both enabled and visible.</remarks>
|
|
|
4155 </member>
|
|
|
4156 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsWindowVisible(System.IntPtr)">
|
|
|
4157 <summary>
|
|
|
4158 The IsWindowVisible function retrieves the visibility state of the specified window.
|
|
|
4159 </summary>
|
|
|
4160 <param name="handle">[in] Handle to the window to test.</param>
|
|
|
4161 <returns>If the specified window, its parent window, its parent's parent window, and so forth, have the WS_VISIBLE style, the return value is nonzero. Otherwise, the return value is zero. Because the return value specifies whether the window has the WS_VISIBLE style, it may be nonzero even if the window is totally obscured by other windows.</returns>
|
|
|
4162 </member>
|
|
|
4163 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.IsZoomed(System.IntPtr)">
|
|
|
4164 <summary>
|
|
|
4165 The IsZoomed function return true is windows is maximized.
|
|
|
4166 </summary>
|
|
|
4167 </member>
|
|
|
4168 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.PostMessage(System.IntPtr,JetBrains.Interop.WinApi.WindowsMessages,System.IntPtr,System.IntPtr)">
|
|
|
4169 <summary>
|
|
|
4170 The PostMessageW function places (posts) a message in the message queue associated with the thread that created the specified window and returns without waiting for the thread to process the message.
|
|
|
4171 </summary>
|
|
|
4172 </member>
|
|
|
4173 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.ScreenToClient(System.IntPtr,System.Drawing.Point)">
|
|
|
4174 <summary>
|
|
|
4175 Converts a point from screen coordinates to window coordinates, returns an empty point on failure.
|
|
|
4176 </summary>
|
|
|
4177 </member>
|
|
|
4178 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.ScreenToClient(System.IntPtr,System.Drawing.Rectangle)">
|
|
|
4179 <summary>
|
|
|
4180 Converts a rectangle from screen coordinates to window coordinates, returns an empty rectangle on failure.
|
|
|
4181 </summary>
|
|
|
4182 </member>
|
|
|
4183 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SendMessageW(System.IntPtr,JetBrains.Interop.WinApi.WindowsMessages,System.IntPtr,System.IntPtr)">
|
|
|
4184 <summary>
|
|
|
4185 The SendMessage function sends the specified message to a window or windows. It calls the window procedure for the specified window and does not return until the window procedure has processed the message.
|
|
|
4186 To send a message and return immediately, use the SendMessageCallback or SendNotifyMessage function. To post a message to a thread's message queue and return immediately, use the PostMessageW or PostThreadMessage function.
|
|
|
4187 </summary>
|
|
|
4188 </member>
|
|
|
4189 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetActiveWindow(System.IntPtr)">
|
|
|
4190 <summary>
|
|
|
4191 The SetActiveWindow function activates a window. The window must be attached to the calling thread's message queue.
|
|
|
4192 </summary>
|
|
|
4193 <param name="hWnd">[in] Handle to the top-level window to be activated.</param>
|
|
|
4194 <returns>If the function succeeds, the return value is the handle to the window that was previously active. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
4195 <remarks>
|
|
|
4196 <para>The SetActiveWindow function activates a window, but not if the application is in the background. The window will be brought into the foreground (top of Z-Order) if its application is in the foreground when the system activates the window. </para>
|
|
|
4197 <para>If the window identified by the hWnd parameter was created by the calling thread, the active window status of the calling thread is set to hWnd. Otherwise, the active window status of the calling thread is set to NULL.</para>
|
|
|
4198 <para>By using the AttachThreadInput function, a thread can attach its input processing to another thread. This allows a thread to call SetActiveWindow to activate a window attached to another thread's message queue. </para>
|
|
|
4199 </remarks>
|
|
|
4200 </member>
|
|
|
4201 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetFocus(System.IntPtr)">
|
|
|
4202 <summary>
|
|
|
4203 The SetFocus function sets the keyboard focus to the specified window. The window must be attached to the calling thread's message queue. The SetFocus function sends a WM_KILLFOCUS message to the window that loses the keyboard focus and a WM_SETFOCUS message to the window that receives the keyboard focus. It also activates either the window that receives the focus or the parent of the window that receives the focus. If a window is active but does not have the focus, any key pressed will produce the WM_SYSCHAR, WM_SYSKEYDOWN, or WM_SYSKEYUP message. If the VK_MENU key is also pressed, the lParam parameter of the message will have bit 30 set. Otherwise, the messages produced do not have this bit set. By using the AttachThreadInput function, a thread can attach its input processing to another thread. This allows a thread to call SetFocus to set the keyboard focus to a window attached to another thread's message queue.
|
|
|
4204 </summary>
|
|
|
4205 <param name="hWnd">[in] Handle to the window that will receive the keyboard input. If this parameter is NULL, keystrokes are ignored. </param>
|
|
|
4206 <returns>If the function succeeds, the return value is the handle to the window that previously had the keyboard focus. If the hWnd parameter is invalid or the window is not attached to the calling thread's message queue, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
4207 </member>
|
|
|
4208 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetForegroundWindow(System.IntPtr)">
|
|
|
4209 <summary>
|
|
|
4210 The SetForegroundWindow function puts the thread that created the specified window into the foreground and
|
|
|
4211 activates the window. Keyboard input is directed to the window, and various visual cues are changed for the user.
|
|
|
4212 The system assigns a slightly higher priority to the thread that created the foreground window than it does to other threads.
|
|
|
4213 </summary>
|
|
|
4214 </member>
|
|
|
4215 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetLayeredWindowAttributes(System.Windows.Forms.IWin32Window,System.Drawing.Color,System.Double,JetBrains.Interop.WinApi.SetLayeredWindowAttributesFlags)">
|
|
|
4216 <summary>
|
|
|
4217 Wraps the <see cref="M:JetBrains.Interop.WinApi.User32Dll.SetLayeredWindowAttributes(System.Void*,System.UInt32,System.Byte,System.UInt32)"/> calls.
|
|
|
4218 </summary>
|
|
|
4219 </member>
|
|
|
4220 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetWindowExStyle(System.Windows.Forms.IWin32Window,JetBrains.Interop.WinApi.WindowExStyles,System.Boolean)">
|
|
|
4221 <summary>
|
|
|
4222 Adds or removes window style bits given by the <paramref name="style"/> parameter (see WS_… in <see cref="T:JetBrains.Interop.WinApi.Win32Declarations"/>), depending on the <paramref name="set"/> value.
|
|
|
4223 </summary>
|
|
|
4224 <returns>Whether the operation succeeded.</returns>
|
|
|
4225 </member>
|
|
|
4226 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetWindowExStyle(System.Void*,JetBrains.Interop.WinApi.WindowExStyles,System.Boolean)">
|
|
|
4227 <summary>
|
|
|
4228 Adds or removes window style bits given by the <paramref name="style"/> parameter (see WS_… in <see cref="T:JetBrains.Interop.WinApi.Win32Declarations"/>), depending on the <paramref name="set"/> value.
|
|
|
4229 </summary>
|
|
|
4230 <returns>Whether the operation succeeded.</returns>
|
|
|
4231 </member>
|
|
|
4232 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetWindowStyle(System.Windows.Forms.IWin32Window,JetBrains.Interop.WinApi.WindowStyles,System.Boolean)">
|
|
|
4233 <summary>
|
|
|
4234 Adds or removes window style bits given by the <paramref name="style"/> parameter (see WS_… in <see cref="T:JetBrains.Interop.WinApi.Win32Declarations"/>), depending on the <paramref name="set"/> value.
|
|
|
4235 </summary>
|
|
|
4236 <returns>Whether the operation succeeded.</returns>
|
|
|
4237 </member>
|
|
|
4238 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetWindowStyle(System.Void*,JetBrains.Interop.WinApi.WindowStyles,System.Boolean)">
|
|
|
4239 <summary>
|
|
|
4240 Adds or removes window style bits given by the <paramref name="style"/> parameter (see WS_… in <see cref="T:JetBrains.Interop.WinApi.Win32Declarations"/>), depending on the <paramref name="set"/> value.
|
|
|
4241 </summary>
|
|
|
4242 <returns>Whether the operation succeeded.</returns>
|
|
|
4243 </member>
|
|
|
4244 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SetWindowStyleRaw(System.Void*,System.UInt32,JetBrains.Interop.WinApi.WindowLongPtrIndex,System.Boolean)">
|
|
|
4245 <summary>
|
|
|
4246 Raw implementation for setting a window style.
|
|
|
4247 </summary>
|
|
|
4248 <param name="hwnd">Handle to the window whose style is being set/reset.</param>
|
|
|
4249 <param name="style">One or more styles.</param>
|
|
|
4250 <param name="index">Index telling whether it would be simple style or extended style.</param>
|
|
|
4251 <param name="set">Whether to set or reset the style.</param>
|
|
|
4252 </member>
|
|
|
4253 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.ShowWindow(System.IntPtr,JetBrains.Interop.WinApi.ShowWindowCommands)">
|
|
|
4254 <summary>
|
|
|
4255 The ShowWindow function sets the specified window's show state.
|
|
|
4256 </summary>
|
|
|
4257 </member>
|
|
|
4258 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.SwitchToThisWindow(System.IntPtr,System.Boolean)">
|
|
|
4259 <summary>
|
|
|
4260 The SwitchToThisWindow function is called to switch focus to a specified window and bring it to the foreground.
|
|
|
4261 </summary>
|
|
|
4262 </member>
|
|
|
4263 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.TryGetWindowClassName(System.IntPtr)">
|
|
|
4264 <summary>
|
|
|
4265 Wnd class name. Throws no exceptions, returns <c>Null</c>.
|
|
|
4266 </summary>
|
|
|
4267 </member>
|
|
|
4268 <member name="M:JetBrains.Interop.WinApi.User32Dll.Helpers.TryLoadStringResource(System.String,System.UInt32)">
|
|
|
4269 <summary>
|
|
|
4270 Loads a Win32 string resource from a native DLL.
|
|
|
4271 Returns <c>Null</c> on errors.
|
|
|
4272 </summary>
|
|
|
4273 </member>
|
|
|
4274 <member name="T:JetBrains.Interop.WinApi.User32Dll.Helpers.EnumWindowsProc">
|
|
|
4275 <summary>
|
|
|
4276 The EnumWindowsProc function is an application-defined callback function used with the EnumWindows or EnumDesktopWindows function. It receives top-level window handles. The WNDENUMPROC type defines a pointer to this callback function. EnumWindowsProc is a placeholder for the application-defined function name.
|
|
|
4277 </summary>
|
|
|
4278 <param name="hwnd">[in] Handle to a top-level window. </param>
|
|
|
4279 <param name="lParam">[in] Specifies the application-defined value given in EnumWindows or EnumDesktopWindows. </param>
|
|
|
4280 <returns>To continue enumeration, the callback function must return TRUE; to stop enumeration, it must return FALSE.</returns>
|
|
|
4281 <remarks>An application must register this callback function by passing its address to EnumWindows or EnumDesktopWindows. </remarks>
|
|
|
4282 </member>
|
|
|
4283 <member name="M:JetBrains.Interop.WinApi.User32Dll.Only32Bit.GetWindowLongPtrW(System.Void*,System.Int32)">
|
|
|
4284 <summary>
|
|
|
4285 The GetWindowLongPtrW function retrieves information about the specified window. The function also retrieves the value at a specified offset into the extra window memory.
|
|
|
4286 </summary>
|
|
|
4287 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
4288 </member>
|
|
|
4289 <member name="M:JetBrains.Interop.WinApi.User32Dll.Only32Bit.SetWindowLongPtrW(System.Void*,System.Int32,System.Void*)">
|
|
|
4290 <summary>
|
|
|
4291 The SetWindowLongPtrW function changes an attribute of the specified window. The function also sets a value at the specified offset in the extra window memory.
|
|
|
4292 </summary>
|
|
|
4293 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
4294 </member>
|
|
|
4295 <member name="M:JetBrains.Interop.WinApi.User32Dll.Only64Bit.GetWindowLongPtrW(System.Void*,System.Int32)">
|
|
|
4296 <summary>
|
|
|
4297 The GetWindowLongPtrW function retrieves information about the specified window. The function also retrieves the value at a specified offset into the extra window memory.
|
|
|
4298 </summary>
|
|
|
4299 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
4300 </member>
|
|
|
4301 <member name="M:JetBrains.Interop.WinApi.User32Dll.Only64Bit.SetWindowLongPtrW(System.Void*,System.Int32,System.Void*)">
|
|
|
4302 <summary>
|
|
|
4303 The SetWindowLongPtrW function changes an attribute of the specified window. The function also sets a value at the specified offset in the extra window memory.
|
|
|
4304 </summary>
|
|
|
4305 <remarks>void* is used instead of IntPtr here for safer casts on x64 systems: IntPtr is explicitly checked and throws an overflow exception.</remarks>
|
|
|
4306 </member>
|
|
|
4307 <member name="T:JetBrains.Interop.WinApi.UxThemeDll">
|
|
|
4308 <summary>
|
|
|
4309 Declarations for the UxTheme.Dll.
|
|
|
4310 Must be 64bit-compatible.
|
|
|
4311 </summary>
|
|
|
4312 <remarks>
|
|
|
4313 IMPORTANT! Rules for authoring the class (v1.1):
|
|
|
4314 (1) All the function declarations MUST be 64-bit aware.
|
|
|
4315 (2) When copypasting from older declarations, you MUST check against the MSDN help or header declaration,
|
|
|
4316 and you MUST ensure that each parameter has a proper size.
|
|
|
4317 (3) Call the Wide version of the functions (UCS-2-LE) unless there's a strong reason for calling the ANSI version
|
|
|
4318 (such a reason MUST be indicated in XmlDoc). <c>CharSet = CharSet.Unicode</c>.
|
|
|
4319 (4) ExactSpelling MUST be TRUE. Add the "…W" suffix wherever needed.
|
|
|
4320 (5) SetLastError SHOULD be considered individually for each function. Setting it to <c>True</c> allows to report the errors,
|
|
|
4321 but slows down the execution of critical members.
|
|
|
4322 (6) These properties MUST be explicitly set on DllImport attributes of EACH import:
|
|
|
4323 CharSet, PreserveSig, SetLastError, ExactSpelling.
|
|
|
4324 (7) CLR names MUST be used for types instead of C# ones, eg "Int32" not "int" and "Int64" not "long".
|
|
|
4325 This greately improves the understanding of the parameter sizes.
|
|
|
4326 (8) Sign of the types MUST be favored, eg "DWORD" is "UInt32" not "Int32".
|
|
|
4327 (9) Unsafe pointer types should be used for explicit and implicit pointers rather than IntPtr.
|
|
|
4328 This way we outline the unsafety of the native calls, and also make it more clear for the 64bit transition.
|
|
|
4329 Eg "HANDLE" is "void*". If the rule forces you to mark some assembly as unsafe, it's an indication a managed utility
|
|
|
4330 incapsulating the call and the handle should be provided in one of the already-unsafe assemblies.
|
|
|
4331 (A) Same rules must apply to members of the structures.
|
|
|
4332 (B) All of the structures MUST have the [StructLayout(LayoutKind.Sequential)], [NoReorder] attributes, as appropriate.
|
|
|
4333 </remarks>
|
|
|
4334 </member>
|
|
|
4335 <member name="M:JetBrains.Interop.WinApi.UxThemeDll.CloseThemeData(System.Void*)">
|
|
|
4336 <summary>
|
|
|
4337 Closes the theme data handle.
|
|
|
4338 </summary>
|
|
|
4339 </member>
|
|
|
4340 <member name="M:JetBrains.Interop.WinApi.UxThemeDll.DrawThemeBackground(System.Void*,System.Void*,System.Int32,System.Int32,JetBrains.Interop.WinApi.RECT*,JetBrains.Interop.WinApi.RECT*)">
|
|
|
4341 <summary>
|
|
|
4342 Draws the border and fill defined by the visual style for the specified control part.
|
|
|
4343 </summary>
|
|
|
4344 </member>
|
|
|
4345 <member name="M:JetBrains.Interop.WinApi.UxThemeDll.IsAvailable">
|
|
|
4346 <summary>
|
|
|
4347 Checks whether the UxTheme DLL is available on this platform.
|
|
|
4348 </summary>
|
|
|
4349 </member>
|
|
|
4350 <member name="M:JetBrains.Interop.WinApi.UxThemeDll.OpenThemeData(System.Void*,System.String)">
|
|
|
4351 <summary>
|
|
|
4352 Opens the theme data for a window and its associated class.
|
|
|
4353 </summary>
|
|
|
4354 </member>
|
|
|
4355 <member name="T:JetBrains.Interop.WinApi.RECT">
|
|
|
4356 <summary>
|
|
|
4357 The RECT structure defines the coordinates of the upper-left and lower-right corners of a rectangle.
|
|
|
4358 By convention, the right and bottom edges of the rectangle are normally considered exclusive. In other words, the pixel whose coordinates are (right, bottom) lies immediately outside of the the rectangle. For example, when RECT is passed to the FillRect function, the rectangle is filled up to, but not including, the right column and bottom row of pixels. This structure is identical to the RECTL structure.
|
|
|
4359 </summary>
|
|
|
4360 </member>
|
|
|
4361 <member name="M:JetBrains.Interop.WinApi.RECT.ToString">
|
|
|
4362 <summary>
|
|
|
4363 Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
4364 </summary>
|
|
|
4365
|
|
|
4366 <returns>
|
|
|
4367 A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
4368 </returns>
|
|
|
4369 <filterpriority>2</filterpriority>
|
|
|
4370 </member>
|
|
|
4371 <member name="T:JetBrains.Interop.WinApi.TH32CS">
|
|
|
4372 <summary>
|
|
|
4373 The portions of the system to be included in the snapshot.
|
|
|
4374 See <see cref="M:JetBrains.Interop.WinApi.Kernel32Dll.CreateToolhelp32Snapshot(System.UInt32,System.UInt32)"/>.
|
|
|
4375 </summary>
|
|
|
4376 </member>
|
|
|
4377 <member name="T:JetBrains.Interop.WinApi.ScrollWindowFlags">
|
|
|
4378 <summary>
|
|
|
4379 Flags for the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.ScrollWindowEx(System.IntPtr,System.Int32,System.Int32,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.RECT@,System.IntPtr,System.IntPtr,JetBrains.Interop.WinApi.ScrollWindowFlags)"/>, <see cref="!:Win32Declarations.ScrollWindowEx(IntPtr,int,int,ref RECT,ref RECT,IntPtr,ref RECT,UI.Interop.ScrollWindowFlags)"/> functions.
|
|
|
4380 </summary>
|
|
|
4381 </member>
|
|
|
4382 <member name="F:JetBrains.Interop.WinApi.ScrollWindowFlags.SW_ERASE">
|
|
|
4383 <summary>
|
|
|
4384 Erases the newly invalidated region by sending a WM_ERASEBKGND message to the window when specified with the SW_INVALIDATE flag.
|
|
|
4385 </summary>
|
|
|
4386 </member>
|
|
|
4387 <member name="F:JetBrains.Interop.WinApi.ScrollWindowFlags.SW_INVALIDATE">
|
|
|
4388 <summary>
|
|
|
4389 Invalidates the region identified by the hrgnUpdate parameter after scrolling.
|
|
|
4390 </summary>
|
|
|
4391 </member>
|
|
|
4392 <member name="F:JetBrains.Interop.WinApi.ScrollWindowFlags.SW_SCROLLCHILDREN">
|
|
|
4393 <summary>
|
|
|
4394 Scrolls all child windows that intersect the rectangle pointed to by the prcScroll parameter. The child windows are scrolled by the number of pixels specified by the dx and dy parameters. The system sends a WM_MOVE message to all child windows that intersect the prcScroll rectangle, even if they do not move.
|
|
|
4395 </summary>
|
|
|
4396 </member>
|
|
|
4397 <member name="F:JetBrains.Interop.WinApi.ScrollWindowFlags.SW_SMOOTHSCROLL">
|
|
|
4398 <summary>
|
|
|
4399 Windows 98/Me, Windows 2000/XP: Scrolls using smooth scrolling. Use the HIWORD portion of the flags parameter to indicate how much time the smooth-scrolling operation should take.
|
|
|
4400 </summary>
|
|
|
4401 </member>
|
|
|
4402 <member name="T:JetBrains.Interop.WinApi.SetWindowPosFlags">
|
|
|
4403 <summary>
|
|
|
4404 Flags for the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowPos(System.IntPtr,System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32,JetBrains.Interop.WinApi.SetWindowPosFlags)"/> fucntion.
|
|
|
4405 </summary>
|
|
|
4406 </member>
|
|
|
4407 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOSIZE">
|
|
|
4408 <summary>
|
|
|
4409 Retains the current size (ignores the cx and cy parameters).
|
|
|
4410 </summary>
|
|
|
4411 </member>
|
|
|
4412 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOMOVE">
|
|
|
4413 <summary>
|
|
|
4414 Retains the current position (ignores X and Y parameters).
|
|
|
4415 </summary>
|
|
|
4416 </member>
|
|
|
4417 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOZORDER">
|
|
|
4418 <summary>
|
|
|
4419 Retains the current Z order (ignores the hWndInsertAfter parameter).
|
|
|
4420 </summary>
|
|
|
4421 </member>
|
|
|
4422 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOREDRAW">
|
|
|
4423 <summary>
|
|
|
4424 Does not redraw changes. If this flag is set, no repainting of any kind occurs. This applies to the client area, the nonclient area (including the title bar and scroll bars), and any part of the parent window uncovered as a result of the window being moved. When this flag is set, the application must explicitly invalidate or redraw any parts of the window and parent window that need redrawing.
|
|
|
4425 </summary>
|
|
|
4426 </member>
|
|
|
4427 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOACTIVATE">
|
|
|
4428 <summary>
|
|
|
4429 Does not activate the window. If this flag is not set, the window is activated and moved to the top of either the topmost or non-topmost group (depending on the setting of the hWndInsertAfter parameter).
|
|
|
4430 </summary>
|
|
|
4431 </member>
|
|
|
4432 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_FRAMECHANGED">
|
|
|
4433 <summary>
|
|
|
4434 Applies new frame styles set using the SetWindowLong function. Sends a WM_NCCALCSIZE message to the window, even if the window's size is not being changed. If this flag is not specified, WM_NCCALCSIZE is sent only when the window's size is being changed.
|
|
|
4435 </summary>
|
|
|
4436 </member>
|
|
|
4437 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_SHOWWINDOW">
|
|
|
4438 <summary>
|
|
|
4439 Displays the window.
|
|
|
4440 </summary>
|
|
|
4441 </member>
|
|
|
4442 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_HIDEWINDOW">
|
|
|
4443 <summary>
|
|
|
4444 Hides the window.
|
|
|
4445 </summary>
|
|
|
4446 </member>
|
|
|
4447 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOCOPYBITS">
|
|
|
4448 <summary>
|
|
|
4449 Discards the entire contents of the client area. If this flag is not specified, the valid contents of the client area are saved and copied back into the client area after the window is sized or repositioned.
|
|
|
4450 </summary>
|
|
|
4451 </member>
|
|
|
4452 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOOWNERZORDER">
|
|
|
4453 <summary>
|
|
|
4454 Does not change the owner window's position in the Z order.
|
|
|
4455 </summary>
|
|
|
4456 </member>
|
|
|
4457 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOSENDCHANGING">
|
|
|
4458 <summary>
|
|
|
4459 Prevents the window from receiving the WM_WINDOWPOSCHANGING message.
|
|
|
4460 </summary>
|
|
|
4461 </member>
|
|
|
4462 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_DEFERERASE">
|
|
|
4463 <summary>
|
|
|
4464 Prevents generation of the WM_SYNCPAINT message.
|
|
|
4465 </summary>
|
|
|
4466 </member>
|
|
|
4467 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_ASYNCWINDOWPOS">
|
|
|
4468 <summary>
|
|
|
4469 If the calling thread and the thread that owns the window are attached to different input queues, the system posts the request to the thread that owns the window. This prevents the calling thread from blocking its execution while other threads process the request.
|
|
|
4470 </summary>
|
|
|
4471 </member>
|
|
|
4472 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOREPOSITION">
|
|
|
4473 <summary>
|
|
|
4474 Same as the <see cref="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_NOOWNERZORDER"/> flag.
|
|
|
4475 </summary>
|
|
|
4476 </member>
|
|
|
4477 <member name="F:JetBrains.Interop.WinApi.SetWindowPosFlags.SWP_DRAWFRAME">
|
|
|
4478 <summary>
|
|
|
4479 Draws a frame (defined in the window's class description) around the window.
|
|
|
4480 </summary>
|
|
|
4481 </member>
|
|
|
4482 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations">
|
|
|
4483 <summary>
|
|
|
4484 Possible raster operations for the <see cref="M:JetBrains.Interop.WinApi.Gdi32Dll.BitBlt(System.Void*,System.Int32,System.Int32,System.Int32,System.Int32,System.Void*,System.Int32,System.Int32,System.UInt32)"/> function.
|
|
|
4485 </summary>
|
|
|
4486 </member>
|
|
|
4487 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.SRCCOPY">
|
|
|
4488 <summary>dest = source</summary>
|
|
|
4489 </member>
|
|
|
4490 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.SRCPAINT">
|
|
|
4491 <summary>dest = source OR dest</summary>
|
|
|
4492 </member>
|
|
|
4493 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.SRCAND">
|
|
|
4494 <summary>dest = source AND dest</summary>
|
|
|
4495 </member>
|
|
|
4496 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.SRCINVERT">
|
|
|
4497 <summary>dest = source XOR dest</summary>
|
|
|
4498 </member>
|
|
|
4499 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.SRCERASE">
|
|
|
4500 <summary>dest = source AND (NOT dest )</summary>
|
|
|
4501 </member>
|
|
|
4502 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.NOTSRCCOPY">
|
|
|
4503 <summary>dest = (NOT source)</summary>
|
|
|
4504 </member>
|
|
|
4505 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.NOTSRCERASE">
|
|
|
4506 <summary>dest = (NOT src) AND (NOT dest)</summary>
|
|
|
4507 </member>
|
|
|
4508 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.MERGECOPY">
|
|
|
4509 <summary>dest = (source AND pattern)</summary>
|
|
|
4510 </member>
|
|
|
4511 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.MERGEPAINT">
|
|
|
4512 <summary>dest = (NOT source) OR dest</summary>
|
|
|
4513 </member>
|
|
|
4514 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.PATCOPY">
|
|
|
4515 <summary>dest = pattern</summary>
|
|
|
4516 </member>
|
|
|
4517 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.PATPAINT">
|
|
|
4518 <summary>dest = DPSnoo</summary>
|
|
|
4519 </member>
|
|
|
4520 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.PATINVERT">
|
|
|
4521 <summary>dest = pattern XOR dest</summary>
|
|
|
4522 </member>
|
|
|
4523 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.DSTINVERT">
|
|
|
4524 <summary>dest = (NOT dest)</summary>
|
|
|
4525 </member>
|
|
|
4526 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.BLACKNESS">
|
|
|
4527 <summary>dest = BLACK</summary>
|
|
|
4528 </member>
|
|
|
4529 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.WHITENESS">
|
|
|
4530 <summary>dest = WHITE</summary>
|
|
|
4531 </member>
|
|
|
4532 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.NOMIRRORBITMAP">
|
|
|
4533 <summary>Do not Mirror the bitmap in this call</summary>
|
|
|
4534 </member>
|
|
|
4535 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.RasterOperations.CAPTUREBLT">
|
|
|
4536 <summary>Include layered windows</summary>
|
|
|
4537 </member>
|
|
|
4538 <member name="T:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags">
|
|
|
4539 <summary>
|
|
|
4540 Flags for the <see cref="M:JetBrains.Interop.WinApi.User32Dll.UpdateLayeredWindow(System.Void*,System.Void*,JetBrains.Interop.WinApi.POINT*,JetBrains.Interop.WinApi.Declarations.Structures.SIZE*,System.Void*,JetBrains.Interop.WinApi.POINT*,System.UInt32,JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION*,System.UInt32)"/> function.
|
|
|
4541 </summary>
|
|
|
4542 </member>
|
|
|
4543 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_COLORKEY">
|
|
|
4544 <summary>
|
|
|
4545 Use crKey as the transparency color. (see <see cref="M:JetBrains.Interop.WinApi.User32Dll.UpdateLayeredWindow(System.Void*,System.Void*,JetBrains.Interop.WinApi.POINT*,JetBrains.Interop.WinApi.Declarations.Structures.SIZE*,System.Void*,JetBrains.Interop.WinApi.POINT*,System.UInt32,JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION*,System.UInt32)"/>)
|
|
|
4546 </summary>
|
|
|
4547 </member>
|
|
|
4548 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_ALPHA">
|
|
|
4549 <summary>
|
|
|
4550 Use pblend as the blend function. If the display mode is 256 colors or less, the effect of this value is the same as the effect of <see cref="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_OPAQUE"/>.
|
|
|
4551 </summary>
|
|
|
4552 </member>
|
|
|
4553 <member name="F:JetBrains.Interop.WinApi.Declarations.Constants.UpdateLayeredWindowFlags.ULW_OPAQUE">
|
|
|
4554 <summary>
|
|
|
4555 Draw an opaque layered window.
|
|
|
4556 </summary>
|
|
|
4557 </member>
|
|
|
4558 <member name="T:JetBrains.Interop.WinApi.Declarations.Structures.SIZE">
|
|
|
4559 <summary>
|
|
|
4560 The SIZE structure specifies the width and height of a rectangle.
|
|
|
4561 </summary>
|
|
|
4562 <remarks>The rectangle dimensions stored in this structure may correspond to viewport extents, window extents, text extents, bitmap dimensions, or the aspect-ratio filter for some extended functions. </remarks>
|
|
|
4563 </member>
|
|
|
4564 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.cx">
|
|
|
4565 <summary>
|
|
|
4566 Specifies the rectangle's width. The units depend on which function uses this.
|
|
|
4567 </summary>
|
|
|
4568 </member>
|
|
|
4569 <member name="F:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.cy">
|
|
|
4570 <summary>
|
|
|
4571 Specifies the rectangle's height. The units depend on which function uses this.
|
|
|
4572 </summary>
|
|
|
4573 </member>
|
|
|
4574 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.Equals(JetBrains.Interop.WinApi.Declarations.Structures.SIZE)">
|
|
|
4575 <summary>
|
|
|
4576 Indicates whether the current object is equal to another object of the same type.
|
|
|
4577 </summary>
|
|
|
4578 <returns>
|
|
|
4579 true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.
|
|
|
4580 </returns>
|
|
|
4581 <param name="other">An object to compare with this object.</param>
|
|
|
4582 </member>
|
|
|
4583 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.Equals(System.Object)">
|
|
|
4584 <summary>
|
|
|
4585 Indicates whether this instance and a specified object are equal.
|
|
|
4586 </summary>
|
|
|
4587 <returns>
|
|
|
4588 true if <paramref name="obj"/> and this instance are the same type and represent the same value; otherwise, false.
|
|
|
4589 </returns>
|
|
|
4590 <param name="obj">Another object to compare to. </param><filterpriority>2</filterpriority>
|
|
|
4591 </member>
|
|
|
4592 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.GetHashCode">
|
|
|
4593 <summary>
|
|
|
4594 Returns the hash code for this instance.
|
|
|
4595 </summary>
|
|
|
4596 <returns>
|
|
|
4597 A 32-bit signed integer that is the hash code for this instance.
|
|
|
4598 </returns>
|
|
|
4599 <filterpriority>2</filterpriority>
|
|
|
4600 </member>
|
|
|
4601 <member name="M:JetBrains.Interop.WinApi.Declarations.Structures.SIZE.ToString">
|
|
|
4602 <summary>
|
|
|
4603 Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
4604 </summary>
|
|
|
4605
|
|
|
4606 <returns>
|
|
|
4607 A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
4608 </returns>
|
|
|
4609 <filterpriority>2</filterpriority>
|
|
|
4610 </member>
|
|
|
4611 <member name="T:JetBrains.Interop.WinApi.StockCursors">
|
|
|
4612 <summary>
|
|
|
4613 Stock cursors enum for <see cref="!:LoadCursor(StockCursors)"/>.
|
|
|
4614 </summary>
|
|
|
4615 </member>
|
|
|
4616 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_APPSTARTING">
|
|
|
4617 <summary>
|
|
|
4618 Standard arrow and small hourglass
|
|
|
4619 </summary>
|
|
|
4620 </member>
|
|
|
4621 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_ARROW">
|
|
|
4622 <summary>
|
|
|
4623 Standard arrow
|
|
|
4624 </summary>
|
|
|
4625 </member>
|
|
|
4626 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_CROSS">
|
|
|
4627 <summary>
|
|
|
4628 Crosshair
|
|
|
4629 </summary>
|
|
|
4630 </member>
|
|
|
4631 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_HAND">
|
|
|
4632 <summary>
|
|
|
4633 Windows 98/Me, Windows 2000/XP: Hand
|
|
|
4634 </summary>
|
|
|
4635 </member>
|
|
|
4636 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_HELP">
|
|
|
4637 <summary>
|
|
|
4638 Arrow and question mark
|
|
|
4639 </summary>
|
|
|
4640 </member>
|
|
|
4641 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_IBEAM">
|
|
|
4642 <summary>
|
|
|
4643 I-beam
|
|
|
4644 </summary>
|
|
|
4645 </member>
|
|
|
4646 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_ICON">
|
|
|
4647 <summary>
|
|
|
4648 Obsolete for applications marked version 4.0 or later.
|
|
|
4649 </summary>
|
|
|
4650 </member>
|
|
|
4651 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_NO">
|
|
|
4652 <summary>
|
|
|
4653 Slashed circle
|
|
|
4654 </summary>
|
|
|
4655 </member>
|
|
|
4656 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZE">
|
|
|
4657 <summary>
|
|
|
4658 Obsolete for applications marked version 4.0 or later. Use IDC_SIZEALL.
|
|
|
4659 </summary>
|
|
|
4660 </member>
|
|
|
4661 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZEALL">
|
|
|
4662 <summary>
|
|
|
4663 Four-pointed arrow pointing north, south, east, and west
|
|
|
4664 </summary>
|
|
|
4665 </member>
|
|
|
4666 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZENESW">
|
|
|
4667 <summary>
|
|
|
4668 /Double-pointed arrow pointing northeast and southwest
|
|
|
4669 </summary>
|
|
|
4670 </member>
|
|
|
4671 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZENS">
|
|
|
4672 <summary>
|
|
|
4673 Double-pointed arrow pointing north and south
|
|
|
4674 </summary>
|
|
|
4675 </member>
|
|
|
4676 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZENWSE">
|
|
|
4677 <summary>
|
|
|
4678 Double-pointed arrow pointing northwest and southeast
|
|
|
4679 </summary>
|
|
|
4680 </member>
|
|
|
4681 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_SIZEWE">
|
|
|
4682 <summary>
|
|
|
4683 Double-pointed arrow pointing west and east
|
|
|
4684 </summary>
|
|
|
4685 </member>
|
|
|
4686 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_UPARROW">
|
|
|
4687 <summary>
|
|
|
4688 Vertical arrow
|
|
|
4689 </summary>
|
|
|
4690 </member>
|
|
|
4691 <member name="F:JetBrains.Interop.WinApi.StockCursors.IDC_WAIT">
|
|
|
4692 <summary>
|
|
|
4693 Hourglass
|
|
|
4694 </summary>
|
|
|
4695 </member>
|
|
|
4696 <member name="T:JetBrains.Interop.WinApi.Win32Declarations">
|
|
|
4697 <summary>
|
|
|
4698 Common Win32 Interop declarations
|
|
|
4699 </summary>
|
|
|
4700 </member>
|
|
|
4701 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.AC_SRC_OVER">
|
|
|
4702 <summary>
|
|
|
4703 When the BlendOp parameter is AC_SRC_OVER , the source bitmap is placed over the destination bitmap based on the alpha values of the source pixels. (<see cref="T:JetBrains.Interop.WinApi.Declarations.Structures.BLENDFUNCTION"/>)
|
|
|
4704 </summary>
|
|
|
4705 </member>
|
|
|
4706 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.AC_SRC_ALPHA">
|
|
|
4707 <summary>
|
|
|
4708 This flag is set when the bitmap has an Alpha channel (that is, per-pixel alpha). Note that the APIs use premultiplied alpha, which means that the red, green and blue channel values in the bitmap must be premultiplied with the alpha channel value. For example, if the alpha channel value is x, the red, green and blue channels must be multiplied by x and divided by 0xff prior to the call.
|
|
|
4709 </summary>
|
|
|
4710 </member>
|
|
|
4711 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.DrawText(System.IntPtr,System.String,System.Int32,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.DrawTextFormatFlags)">
|
|
|
4712 <summary>
|
|
|
4713 The DrawText function draws formatted text in the specified rectangle. It formats the text according to the specified method (expanding tabs, justifying characters, breaking lines, and so forth).
|
|
|
4714 </summary>
|
|
|
4715 <returns>If the function succeeds, the return value is the height of the text in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the offset from lpRect->top to the bottom of the drawn text
|
|
|
4716 If the function fails, the return value is zero.
|
|
|
4717 Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
4718 </member>
|
|
|
4719 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetUpdateRgn(System.IntPtr,System.IntPtr,System.Boolean)">
|
|
|
4720 <summary>
|
|
|
4721 The GetUpdateRgn function retrieves the update region of a window by copying it into the specified region. The coordinates of the update region are relative to the upper-left corner of the window (that is, they are client coordinates).
|
|
|
4722 </summary>
|
|
|
4723 <param name="hWnd">[in] Handle to the window with an update region that is to be retrieved.</param>
|
|
|
4724 <param name="hRgn">[in] Handle to the region to receive the update region.</param>
|
|
|
4725 <param name="bErase">[in] Specifies whether the window background should be erased and whether nonclient areas of child windows should be drawn. If this parameter is FALSE, no drawing is done.</param>
|
|
|
4726 <returns>The return value indicates the complexity of the resulting region; it can be one of the following values.</returns>
|
|
|
4727 <remarks>The BeginPaint function automatically validates the update region, so any call to GetUpdateRgn made immediately after the call to BeginPaint retrieves an empty update region.</remarks>
|
|
|
4728 </member>
|
|
|
4729 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetAncestor(System.IntPtr,JetBrains.Interop.WinApi.GetAncestorFlags)">
|
|
|
4730 <summary>
|
|
|
4731 The GetAncestor function retrieves the handle to the ancestor of the specified window.
|
|
|
4732 </summary>
|
|
|
4733 <param name="hwnd">[in] Handle to the window whose ancestor is to be retrieved. If this parameter is the desktop window, the function returns <c>NULL</c>. </param>
|
|
|
4734 <param name="flags">[in] Specifies the ancestor to be retrieved. This parameter can be one of the following values.</param>
|
|
|
4735 <returns>The return value is the handle to the ancestor window.</returns>
|
|
|
4736 </member>
|
|
|
4737 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetWindowRect(System.IntPtr)">
|
|
|
4738 <summary>
|
|
|
4739 Calls <c>WinAPI::GetWindowRect</c>.
|
|
|
4740 </summary>
|
|
|
4741 </member>
|
|
|
4742 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.AdjustWindowRectEx(JetBrains.Interop.WinApi.RECT@,System.UInt32,System.Int32,System.UInt32)">
|
|
|
4743 <summary>
|
|
|
4744 The AdjustWindowRectEx function calculates the required size of the window rectangle, based on the desired size of the client rectangle. The window rectangle can then be passed to the CreateWindowEx function to create a window whose client area is the desired size.
|
|
|
4745 </summary>
|
|
|
4746 <param name="lpRect">[in, out] Pointer to a RECT structure that contains the coordinates of the top-left and bottom-right corners of the desired client area. When the function returns, the structure contains the coordinates of the top-left and bottom-right corners of the window to accommodate the desired client area. </param>
|
|
|
4747 <param name="dwStyle">[in] Specifies the window style of the window whose required size is to be calculated. Note that you cannot specify the WS_OVERLAPPED style. </param>
|
|
|
4748 <param name="bMenu">[in] Specifies whether the window has a menu.</param>
|
|
|
4749 <param name="dwExStyle">[in] Specifies the extended window style of the window whose required size is to be calculated. For more information, see CreateWindowEx.</param>
|
|
|
4750 <returns>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. </returns>
|
|
|
4751 </member>
|
|
|
4752 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.MoveWindow(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
|
4753 <summary>
|
|
|
4754 The MoveWindow function changes the position and dimensions of the specified window. For a top-level window, the position and dimensions are relative to the upper-left corner of the screen. For a child window, they are relative to the upper-left corner of the parent window's client area.
|
|
|
4755 </summary>
|
|
|
4756 <param name="hWnd">[in] Handle to the window. </param>
|
|
|
4757 <param name="X">[in] Specifies the new position of the left side of the window. </param>
|
|
|
4758 <param name="Y">[in] Specifies the new position of the top of the window. </param>
|
|
|
4759 <param name="nWidth">[in] Specifies the new width of the window. </param>
|
|
|
4760 <param name="nHeight">[in] Specifies the new height of the window. </param>
|
|
|
4761 <param name="bRepaint">[in] Specifies whether the window is to be repainted. If this parameter is TRUE, the window receives a message. If the parameter is FALSE, no repainting of any kind occurs. This applies to the client area, the nonclient area (including the title bar and scroll bars), and any part of the parent window uncovered as a result of moving a child window. </param>
|
|
|
4762 <returns>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.</returns>
|
|
|
4763 </member>
|
|
|
4764 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetWindowText(System.IntPtr,System.Text.StringBuilder,System.Int32)">
|
|
|
4765 <summary>
|
|
|
4766 The GetWindowText function copies the text of the specified window's title bar (if it has one) into a buffer. If the specified window is a control, the text of the control is copied. However, GetWindowText cannot retrieve the text of a control in another application.
|
|
|
4767 </summary>
|
|
|
4768 <param name="hWnd">[in] Handle to the window or control containing the text. </param>
|
|
|
4769 <param name="lpString">[out] Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character. </param>
|
|
|
4770 <param name="nMaxCount">[in] Specifies the maximum number of characters to copy to the buffer, including the NULL character. If the text exceeds this limit, it is truncated. </param>
|
|
|
4771 <returns>If the function succeeds, the return value is the length, in characters, of the copied string, not including the terminating NULL character. If the window has no title bar or text, if the title bar is empty, or if the window or control handle is invalid, the return value is zero. To get extended error information, call GetLastError. This function cannot retrieve the text of an edit control in another application.</returns>
|
|
|
4772 </member>
|
|
|
4773 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetWindowTextLength(System.IntPtr)">
|
|
|
4774 <summary>
|
|
|
4775 The GetWindowTextLength function retrieves the length, in characters, of the specified window's title bar text (if the window has a title bar). If the specified window is a control, the function retrieves the length of the text within the control. However, GetWindowTextLength cannot retrieve the length of the text of an edit control in another application.
|
|
|
4776 </summary>
|
|
|
4777 <param name="hWnd">[in] Handle to the window or control.</param>
|
|
|
4778 <returns>If the function succeeds, the return value is the length, in characters, of the text. Under certain conditions, this value may actually be greater than the length of the text. For more information, see the following Remarks section. If the window has no text, the return value is zero. To get extended error information, call GetLastError. </returns>
|
|
|
4779 </member>
|
|
|
4780 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.EndTask(System.IntPtr,System.Int32,System.Int32)">
|
|
|
4781 <summary>
|
|
|
4782 The EndTask function is called to forcibly close a specified window.
|
|
|
4783 </summary>
|
|
|
4784 <param name="hWnd">[in] Handle to the window to be closed. </param>
|
|
|
4785 <param name="fShutDown">[in] Ignored. Must be <c>FALSE</c>. </param>
|
|
|
4786 <param name="fForce">[in] A TRUE for this parameter will force the destruction of the window if an initial attempt fails to gently close the window using WM_CLOSE. With a FALSE for this parameter, only the close with WM_CLOSE is attempted.</param>
|
|
|
4787 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is FALSE. To get extended error information, call GetLastError. </returns>
|
|
|
4788 </member>
|
|
|
4789 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.ScrollWindowEx(System.IntPtr,System.Int32,System.Int32,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.RECT@,System.IntPtr,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.ScrollWindowFlags)">
|
|
|
4790 <summary>
|
|
|
4791 The ScrollWindowEx function scrolls the contents of the specified window's client area.
|
|
|
4792 </summary>
|
|
|
4793 <param name="hWnd">[in] Handle to the window where the client area is to be scrolled. </param>
|
|
|
4794 <param name="dx">[in] Specifies the amount, in device units, of horizontal scrolling. This parameter must be a negative value to scroll to the left.</param>
|
|
|
4795 <param name="dy">[in] Specifies the amount, in device units, of vertical scrolling. This parameter must be a negative value to scroll up. </param>
|
|
|
4796 <param name="prcScroll">[in] Pointer to a RECT structure that specifies the portion of the client area to be scrolled. If this parameter is NULL, the entire client area is scrolled.</param>
|
|
|
4797 <param name="prcClip">[in] Pointer to a RECT structure that contains the coordinates of the clipping rectangle. Only device bits within the clipping rectangle are affected. Bits scrolled from the outside of the rectangle to the inside are painted; bits scrolled from the inside of the rectangle to the outside are not painted. This parameter may be NULL.</param>
|
|
|
4798 <param name="hrgnUpdate">[in] Handle to the region that is modified to hold the region invalidated by scrolling. This parameter may be NULL.</param>
|
|
|
4799 <param name="prcUpdate">[out] Pointer to a RECT structure that receives the boundaries of the rectangle invalidated by scrolling. This parameter may be NULL.</param>
|
|
|
4800 <param name="flags">[in] Specifies flags that control scrolling. This parameter can be one of the following values. </param>
|
|
|
4801 <returns>If the function succeeds, the return value is <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.SIMPLEREGION"/> (rectangular invalidated region), <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.COMPLEXREGION"/> (nonrectangular invalidated region; overlapping rectangles), or <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.NULLREGION"/> (no invalidated region).
|
|
|
4802 If the function fails, the return value is <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.ERROR"/>. To get extended error information, call GetLastError.</returns>
|
|
|
4803 </member>
|
|
|
4804 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.ScrollWindowEx(System.IntPtr,System.Int32,System.Int32,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.RECT@,System.IntPtr,System.IntPtr,JetBrains.Interop.WinApi.ScrollWindowFlags)">
|
|
|
4805 <summary>
|
|
|
4806 The ScrollWindowEx function scrolls the contents of the specified window's client area.
|
|
|
4807 </summary>
|
|
|
4808 <param name="hWnd">[in] Handle to the window where the client area is to be scrolled. </param>
|
|
|
4809 <param name="dx">[in] Specifies the amount, in device units, of horizontal scrolling. This parameter must be a negative value to scroll to the left.</param>
|
|
|
4810 <param name="dy">[in] Specifies the amount, in device units, of vertical scrolling. This parameter must be a negative value to scroll up. </param>
|
|
|
4811 <param name="prcScroll">[in] Pointer to a RECT structure that specifies the portion of the client area to be scrolled. If this parameter is NULL, the entire client area is scrolled.</param>
|
|
|
4812 <param name="prcClip">[in] Pointer to a RECT structure that contains the coordinates of the clipping rectangle. Only device bits within the clipping rectangle are affected. Bits scrolled from the outside of the rectangle to the inside are painted; bits scrolled from the inside of the rectangle to the outside are not painted. This parameter may be NULL.</param>
|
|
|
4813 <param name="hrgnUpdate">[in] Handle to the region that is modified to hold the region invalidated by scrolling. This parameter may be NULL.</param>
|
|
|
4814 <param name="prcUpdate">[out] Pointer to a RECT structure that receives the boundaries of the rectangle invalidated by scrolling. This parameter may be NULL.</param>
|
|
|
4815 <param name="flags">[in] Specifies flags that control scrolling. This parameter can be one of the following values. </param>
|
|
|
4816 <returns>If the function succeeds, the return value is <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.SIMPLEREGION"/> (rectangular invalidated region), <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.COMPLEXREGION"/> (nonrectangular invalidated region; overlapping rectangles), or <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.NULLREGION"/> (no invalidated region).
|
|
|
4817 If the function fails, the return value is <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.ERROR"/>. To get extended error information, call GetLastError.</returns>
|
|
|
4818 </member>
|
|
|
4819 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.FindWindowEx(System.IntPtr,System.IntPtr,System.String,System.String)">
|
|
|
4820 <summary>
|
|
|
4821 The FindWindowEx function retrieves a handle to a window whose class name and window name match the specified strings. The function searches child windows, beginning with the one following the specified child window. This function does not perform a case-sensitive search.
|
|
|
4822 If the lpszWindow parameter is not NULL, FindWindowEx calls the GetWindowText function to retrieve the window name for comparison. For a description of a potential problem that can arise, see the Remarks section of GetWindowText.
|
|
|
4823 </summary>
|
|
|
4824 <param name="hwndParent">[in] Handle to the parent window whose child windows are to be searched. If hwndParent is NULL, the function uses the desktop window as the parent window. The function searches among windows that are child windows of the desktop. Microsoft Windows 2000 and Windows XP: If hwndParent is HWND_MESSAGE, the function searches all message-only windows. </param>
|
|
|
4825 <param name="hwndChildAfter">[in] Handle to a child window. The search begins with the next child window in the Z order. The child window must be a direct child window of hwndParent, not just a descendant window. If hwndChildAfter is NULL, the search begins with the first child window of hwndParent. Note that if both hwndParent and hwndChildAfter are NULL, the function searches all top-level and message-only windows. </param>
|
|
|
4826 <param name="lpszClass">[in] Pointer to a null-terminated string that specifies the class name or a class atom created by a previous call to the RegisterClass or RegisterClassEx function. The atom must be placed in the low-order word of lpszClass; the high-order word must be zero.If lpszClass is a string, it specifies the window class name. The class name can be any name registered with RegisterClass or RegisterClassEx, or any of the predefined control-class names, or it can be MAKEINTATOM(0x800). In this latter case, 0x8000 is the atom for a menu class. For more information, see the Remarks section of this topic.</param>
|
|
|
4827 <param name="lpszWindow">[in] Pointer to a null-terminated string that specifies the window name (the window's title). If this parameter is NULL, all window names match. </param>
|
|
|
4828 <returns>If the function succeeds, the return value is a handle to the window that has the specified class and window names. If the function fails, the return value is NULL. To get extended error information, call GetLastError. </returns>
|
|
|
4829 </member>
|
|
|
4830 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.CreateCompatibleDC(System.IntPtr)">
|
|
|
4831 <summary>
|
|
|
4832 The CreateCompatibleDC function creates a memory device context (DC) compatible with the specified device.
|
|
|
4833 </summary>
|
|
|
4834 <param name="hdc">Handle to an existing DC. If this handle is NULL, the function creates a memory DC compatible with the application's current screen.</param>
|
|
|
4835 <returns>If the function succeeds, the return value is the handle to a memory DC. If the function fails, the return value is NULL.</returns>
|
|
|
4836 </member>
|
|
|
4837 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.CreateCompatibleBitmap(System.IntPtr,System.Int32,System.Int32)">
|
|
|
4838 <summary>
|
|
|
4839 The CreateCompatibleBitmap function creates a bitmap compatible with the device that is associated with the specified device context.
|
|
|
4840 </summary>
|
|
|
4841 <param name="hdc">handle to DC</param>
|
|
|
4842 <param name="nWidth">width of bitmap, in pixels</param>
|
|
|
4843 <param name="nHeight">height of bitmap, in pixels</param>
|
|
|
4844 <returns>If the function succeeds, the return value is a handle to the compatible bitmap (DDB). If the function fails, the return value is NULL.</returns>
|
|
|
4845 </member>
|
|
|
4846 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.DeleteDC(System.IntPtr)">
|
|
|
4847 <summary>
|
|
|
4848 The DeleteDC function deletes the specified device context (DC).
|
|
|
4849 </summary>
|
|
|
4850 <param name="hDC">handle to DC</param>
|
|
|
4851 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.</returns>
|
|
|
4852 </member>
|
|
|
4853 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.StrFormatByteSize64A(System.Int64,System.Byte[],System.UInt32)">
|
|
|
4854 <summary>
|
|
|
4855 Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.
|
|
|
4856 </summary>
|
|
|
4857 <param name="nSize">Numeric value to be converted.</param>
|
|
|
4858 <param name="pBuffer">Pointer to a buffer to hold the converted number. Note: this function is bound to call the ANSI version.</param>
|
|
|
4859 <param name="nBufSize">Size of the buffer, in characters. Note: in our case, in bytes.</param>
|
|
|
4860 <returns>Returns the address of the converted string, or <see cref="F:System.IntPtr.Zero"/> if the conversion fails.</returns>
|
|
|
4861 <remarks>
|
|
|
4862 The following table illustrates how this function converts a numeric value into a text string.
|
|
|
4863
|
|
|
4864 Numeric value -> Text string
|
|
|
4865 532 532 -> bytes
|
|
|
4866 1340 -> 1.30KB
|
|
|
4867 23506 -> 22.9KB
|
|
|
4868 2400016 -> 2.29MB
|
|
|
4869 2400000000 -> 2.23GB
|
|
|
4870 </remarks>
|
|
|
4871 </member>
|
|
|
4872 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.StrFormatByteSize64A(System.Int64,System.Text.StringBuilder,System.UInt32)">
|
|
|
4873 <summary>
|
|
|
4874 Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.
|
|
|
4875 </summary>
|
|
|
4876 <param name="nSize">Numeric value to be converted.</param>
|
|
|
4877 <param name="pBuffer">Pointer to a buffer to hold the converted number. Note: this function is bound to call the ANSI version.</param>
|
|
|
4878 <param name="nBufSize">Size of the buffer, in characters. Note: in our case, in bytes.</param>
|
|
|
4879 <returns>Returns the address of the converted string, or <see cref="F:System.IntPtr.Zero"/> if the conversion fails.</returns>
|
|
|
4880 <remarks>
|
|
|
4881 The following table illustrates how this function converts a numeric value into a text string.
|
|
|
4882
|
|
|
4883 Numeric value -> Text string
|
|
|
4884 532 532 -> bytes
|
|
|
4885 1340 -> 1.30KB
|
|
|
4886 23506 -> 22.9KB
|
|
|
4887 2400016 -> 2.29MB
|
|
|
4888 2400000000 -> 2.23GB
|
|
|
4889 </remarks>
|
|
|
4890 </member>
|
|
|
4891 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.StrFormatByteSize(System.Int64)">
|
|
|
4892 <summary>
|
|
|
4893 Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.
|
|
|
4894 </summary>
|
|
|
4895 <param name="nSize">Numeric value to be converted.</param>
|
|
|
4896 <returns>Returns the size string.</returns>
|
|
|
4897 <remarks>
|
|
|
4898 The following table illustrates how this function converts a numeric value into a text string.
|
|
|
4899
|
|
|
4900 Numeric value -> Text string
|
|
|
4901 532 532 -> bytes
|
|
|
4902 1340 -> 1.30KB
|
|
|
4903 23506 -> 22.9KB
|
|
|
4904 2400016 -> 2.29MB
|
|
|
4905 2400000000 -> 2.23GB
|
|
|
4906 </remarks>
|
|
|
4907 </member>
|
|
|
4908 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowOrgEx(System.IntPtr,System.Int32,System.Int32,JetBrains.Interop.WinApi.POINTAPI@)">
|
|
|
4909 <summary>
|
|
|
4910 The SetWindowOrgEx function specifies which window point maps to the viewport origin (0,0).
|
|
|
4911 </summary>
|
|
|
4912 <param name="hdc">[in] Handle to the device context.</param>
|
|
|
4913 <param name="X">[in] Specifies the x-coordinate, in logical units, of the new window origin.</param>
|
|
|
4914 <param name="Y">[in] Specifies the y-coordinate, in logical units, of the new window origin.</param>
|
|
|
4915 <param name="lpPoint">[out] Pointer to a POINT structure that receives the previous origin of the window, in logical units. If lpPoint is NULL, this parameter is not used.</param>
|
|
|
4916 <returns>If the function succeeds, the return value is nonzero.
|
|
|
4917 If the function fails, the return value is zero.</returns>
|
|
|
4918 </member>
|
|
|
4919 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.ExtSelectClipRgn(System.IntPtr,System.IntPtr,JetBrains.Interop.WinApi.CombineRgnStyles)">
|
|
|
4920 <summary>
|
|
|
4921 The ExtSelectClipRgn function combines the specified region with the current clipping region using the specified mode.
|
|
|
4922 </summary>
|
|
|
4923 <param name="hdc">[in] Handle to the device context. </param>
|
|
|
4924 <param name="hrgn">[in] Handle to the region to be selected. This handle can only be NULL when the RGN_COPY mode is specified.</param>
|
|
|
4925 <param name="fnMode">[in] Specifies the operation to be performed. It must be one of the following values. <see cref="T:JetBrains.Interop.WinApi.CombineRgnStyles"/></param>
|
|
|
4926 <returns>The return value specifies the new clipping region's complexity; it can be one of the following values. </returns>
|
|
|
4927 <remarks>If an error occurs when this function is called, the previous clipping region for the specified device context is not affected. The ExtSelectClipRgn function assumes that the coordinates for the specified region are specified in device units. Only a copy of the region identified by the hrgn parameter is used. The region itself can be reused after this call or it can be deleted. </remarks>
|
|
|
4928 </member>
|
|
|
4929 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.CreateRectRgn(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
|
4930 <summary>
|
|
|
4931 The CreateRectRgn function creates a rectangular region.
|
|
|
4932 </summary>
|
|
|
4933 <param name="nLeftRect">[in] Specifies the x-coordinate of the upper-left corner of the region in logical units. </param>
|
|
|
4934 <param name="nTopRect">[in] Specifies the y-coordinate of the upper-left corner of the region in logical units. </param>
|
|
|
4935 <param name="nRightRect">[in] Specifies the x-coordinate of the lower-right corner of the region in logical units.</param>
|
|
|
4936 <param name="nBottomRect">[in] Specifies the y-coordinate of the lower-right corner of the region in logical units.</param>
|
|
|
4937 <returns></returns>
|
|
|
4938 </member>
|
|
|
4939 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.CombineRgn(System.IntPtr,System.IntPtr,System.IntPtr,JetBrains.Interop.WinApi.CombineRgnStyles)">
|
|
|
4940 <summary>
|
|
|
4941 The CombineRgn function combines two regions and stores the result in a third region. The two regions are combined according to the specified mode.
|
|
|
4942 </summary>
|
|
|
4943 <param name="hrgnDest">[in] Handle to a new region with dimensions defined by combining two other regions. (This region must exist before CombineRgn is called.) </param>
|
|
|
4944 <param name="hrgnSrc1">[in] Handle to the first of two regions to be combined.</param>
|
|
|
4945 <param name="hrgnSrc2">[in] Handle to the second of two regions to be combined.</param>
|
|
|
4946 <param name="fnCombineMode">[in] Specifies a mode indicating how the two regions will be combined. This parameter can be one of the following values. </param>
|
|
|
4947 <returns>The return value specifies the type of the resulting region. It can be one of the following values. </returns>
|
|
|
4948 <remarks>The three regions need not be distinct. For example, the hrgnSrc1 parameter can equal the hrgnDest parameter. </remarks>
|
|
|
4949 </member>
|
|
|
4950 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowsHookEx(JetBrains.Interop.WinApi.HookType,JetBrains.Interop.WinApi.Win32Declarations.HookProc,System.IntPtr,System.Int32)">
|
|
|
4951 <summary>
|
|
|
4952 The SetWindowsHookEx function installs an application-defined hook procedure into a hook chain. You would install a hook procedure to monitor the system for certain types of events. These events are associated either with a specific thread or with all threads in the same desktop as the calling thread.
|
|
|
4953 </summary>
|
|
|
4954 <returns>If the function succeeds, the return value is the handle to the hook procedure.
|
|
|
4955 If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
4956 </member>
|
|
|
4957 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.LoadCursor(System.IntPtr,System.IntPtr)">
|
|
|
4958 <summary>
|
|
|
4959 The LoadCursor function loads the specified cursor resource from the executable (.EXE) file associated with an application instance.
|
|
|
4960 </summary>
|
|
|
4961 <param name="hInstance">[in] Handle to an instance of the module whose executable file contains the cursor to be loaded.</param>
|
|
|
4962 <param name="cursor">[in] Pointer to a null-terminated string that contains the name of the cursor resource to be loaded. Alternatively, this parameter can consist of the resource identifier in the low-order word and zero in the high-order word. The MAKEINTRESOURCE macro can also be used to create this value. To use one of the predefined cursors, the application must set the hInstance parameter to NULL and the lpCursorName parameter to one the following values:</param>
|
|
|
4963 <returns>If the function succeeds, the return value is the handle to the newly loaded cursor. If the function fails, the return value is NULL. To get extended error information, call GetLastError.</returns>
|
|
|
4964 </member>
|
|
|
4965 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.LoadCursor(JetBrains.Interop.WinApi.StockCursors)">
|
|
|
4966 <summary>
|
|
|
4967 Loads the cursor by calling the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.LoadCursor(System.IntPtr,System.IntPtr)"/> WinAPI function.
|
|
|
4968 </summary>
|
|
|
4969 </member>
|
|
|
4970 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.GetStockObject(JetBrains.Interop.WinApi.Win32Declarations.StockObject)">
|
|
|
4971 <summary>
|
|
|
4972 The GetStockObject function retrieves a handle to one of the stock pens, brushes, fonts, or palettes.
|
|
|
4973 </summary>
|
|
|
4974 </member>
|
|
|
4975 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.DrawFrameControl(System.IntPtr,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.Win32Declarations.FrameControlType,JetBrains.Interop.WinApi.Win32Declarations.FrameControlState)">
|
|
|
4976 <summary>
|
|
|
4977 The DrawFrameControl function draws a frame control of the specified type and style.
|
|
|
4978 </summary>
|
|
|
4979 <param name="hdc">[in] Handle to the device context of the window in which to draw the control.</param>
|
|
|
4980 <param name="bounds">[in] Pointer to a RECT structure that contains the logical coordinates of the bounding rectangle for frame control.</param>
|
|
|
4981 <param name="frameControlType">[in] Specifies the type of frame control to draw. This parameter can be one of the following values.</param>
|
|
|
4982 <param name="frameControlState">[in] Specifies the initial state of the frame control. If uType is DFC_BUTTON, uState can be one of the following values.</param>
|
|
|
4983 <returns>If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. Windows NT/2000/XP: To get extended error information, call GetLastError.</returns>
|
|
|
4984 </member>
|
|
|
4985 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.SetDCBrushColor(System.IntPtr,System.Int32)">
|
|
|
4986 <summary>
|
|
|
4987 SetDCBrushColor function sets the current device context (DC) brush color to the specified color value. If the device cannot represent the specified color value, the color is set to the nearest physical color.
|
|
|
4988 </summary>
|
|
|
4989 <param name="hdc">[in] Handle to the DC.</param>
|
|
|
4990 <param name="colorref">[in] Specifies the new brush color.</param>
|
|
|
4991 <returns>If the function succeeds, the return value specifies the previous DC brush color as a COLORREF value. If the function fails, the return value is CLR_INVALID.</returns>
|
|
|
4992 </member>
|
|
|
4993 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.VarR8FromStr(System.String,System.Int32,System.Int32,System.Double@)">
|
|
|
4994 <summary>
|
|
|
4995 This function converts variant data types to double from OLECHAR.
|
|
|
4996 Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.
|
|
|
4997 </summary>
|
|
|
4998 </member>
|
|
|
4999 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuEx(System.IntPtr,JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags,System.Int32,System.Int32,System.IntPtr,System.IntPtr)">
|
|
|
5000 <summary>
|
|
|
5001 The TrackPopupMenuEx function displays a shortcut menu at the specified location and tracks the selection of items on the shortcut menu. The shortcut menu can appear anywhere on the screen.
|
|
|
5002 </summary>
|
|
|
5003 <param name="hmenu">[in] Handle to the shortcut menu to be displayed. This handle can be obtained by calling the CreatePopupMenu function to create a new shortcut menu or by calling the GetSubMenu function to retrieve a handle to a submenu associated with an existing menu item.</param>
|
|
|
5004 <param name="fuFlags">[in] Specifies function options. Use one of the following flags to specify how the function positions the shortcut menu horizontally.</param>
|
|
|
5005 <param name="x">[in] Horizontal location of the shortcut menu, in screen coordinates. </param>
|
|
|
5006 <param name="y">[in] Vertical location of the shortcut menu, in screen coordinates. </param>
|
|
|
5007 <param name="hwnd">[in] Handle to the window that owns the shortcut menu. This window receives all messages from the menu. The window does not receive a WM_COMMAND message from the menu until the function returns. If you specify TPM_NONOTIFY in the fuFlags parameter, the function does not send messages to the window identified by hwnd. However, you must still pass a window handle in hwnd. It can be any window handle from your application.</param>
|
|
|
5008 <param name="lptpm_PassNullHere">[in] Pointer to a TPMPARAMS structure that specifies an area of the screen the menu should not overlap. This parameter can be NULL. </param>
|
|
|
5009 <returns>If you specify TPM_RETURNCMD in the fuFlags parameter, the return value is the menu-item identifier of the item that the user selected. If the user cancels the menu without making a selection, or if an error occurs, then the return value is zero. If you do not specify TPM_RETURNCMD in the fuFlags parameter, the return value is nonzero if the function succeeds and zero if it fails. To get extended error information, call GetLastError.</returns>
|
|
|
5010 </member>
|
|
|
5011 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.DwmExtendFrameIntoClientArea(System.IntPtr,JetBrains.Interop.WinApi.Win32Declarations.MARGINS)">
|
|
|
5012 <summary>
|
|
|
5013 Extends the window frame behind the client area.
|
|
|
5014 If Desktop Window Manager (DWM) composition is toggled, this function must be called again. Handle the WM_DWMCOMPOSITIONCHANGED message for composition change notification.
|
|
|
5015 Negative margins are used to create the "sheet of glass" effect where the client area is rendered as a solid surface with no window border.
|
|
|
5016 </summary>
|
|
|
5017 <param name="hwnd">The handle to the window for which the frame is extended into the client area.</param>
|
|
|
5018 <param name="margins"><see cref="T:JetBrains.Interop.WinApi.Win32Declarations.MARGINS"/> that describes the margins to use when extending the frame into the client area.</param>
|
|
|
5019 <returns>Returns S_OK if successful, or an error value otherwise.</returns>
|
|
|
5020 </member>
|
|
|
5021 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.RegionResult">
|
|
|
5022 <summary>
|
|
|
5023 The return value specifies the new clipping region's complexity; it can be one of the following values.
|
|
|
5024 </summary>
|
|
|
5025 </member>
|
|
|
5026 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.ERROR">
|
|
|
5027 <summary>
|
|
|
5028 An error occurred.
|
|
|
5029 </summary>
|
|
|
5030 </member>
|
|
|
5031 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.NULLREGION">
|
|
|
5032 <summary>
|
|
|
5033 Region is empty.
|
|
|
5034 </summary>
|
|
|
5035 </member>
|
|
|
5036 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.SIMPLEREGION">
|
|
|
5037 <summary>
|
|
|
5038 Region is a single rectangle.
|
|
|
5039 </summary>
|
|
|
5040 </member>
|
|
|
5041 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.COMPLEXREGION">
|
|
|
5042 <summary>
|
|
|
5043 Region is more than one rectangle.
|
|
|
5044 </summary>
|
|
|
5045 </member>
|
|
|
5046 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.RegionResult.RGN_ERROR">
|
|
|
5047 <summary>
|
|
|
5048 An error occurred.
|
|
|
5049 </summary>
|
|
|
5050 </member>
|
|
|
5051 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.HookProc">
|
|
|
5052 <summary>
|
|
|
5053 Hook delegate for the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowsHookEx(JetBrains.Interop.WinApi.HookType,JetBrains.Interop.WinApi.Win32Declarations.HookProc,System.IntPtr,System.Int32)"/> function.
|
|
|
5054 </summary>
|
|
|
5055 </member>
|
|
|
5056 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.StatusBarStyles">
|
|
|
5057 <summary>
|
|
|
5058 Styles and flags for the status bar.
|
|
|
5059 </summary>
|
|
|
5060 </member>
|
|
|
5061 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.StatusBarBorders">
|
|
|
5062 <summary>
|
|
|
5063 Identifies the status bar borders for use with the messages like <see cref="F:JetBrains.Interop.WinApi.WindowsMessages.SB_GETBORDERS"/>.
|
|
|
5064 </summary>
|
|
|
5065 </member>
|
|
|
5066 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StatusBarBorders.Horizontal">
|
|
|
5067 <summary>
|
|
|
5068 The horizontal border between the parts and the edges of the window.
|
|
|
5069 </summary>
|
|
|
5070 </member>
|
|
|
5071 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StatusBarBorders.Vertical">
|
|
|
5072 <summary>
|
|
|
5073 The vertical border between the parts and the edges of the window.
|
|
|
5074 </summary>
|
|
|
5075 </member>
|
|
|
5076 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StatusBarBorders.Separator">
|
|
|
5077 <summary>
|
|
|
5078 The spacing between the adjacent status bar parts.
|
|
|
5079 </summary>
|
|
|
5080 </member>
|
|
|
5081 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.StockObject">
|
|
|
5082 <summary>
|
|
|
5083 The stock GDI objects for the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.GetStockObject(JetBrains.Interop.WinApi.Win32Declarations.StockObject)"/> function.
|
|
|
5084 </summary>
|
|
|
5085 </member>
|
|
|
5086 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.BLACK_BRUSH">
|
|
|
5087 <summary>
|
|
|
5088 Black brush.
|
|
|
5089 </summary>
|
|
|
5090 </member>
|
|
|
5091 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DKGRAY_BRUSH">
|
|
|
5092 <summary>
|
|
|
5093 Dark gray brush.
|
|
|
5094 </summary>
|
|
|
5095 </member>
|
|
|
5096 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DC_BRUSH">
|
|
|
5097 <summary>
|
|
|
5098 Windows 2000/XP: Solid color brush. The default color is white. The color can be changed by using the SetDCBrushColor function. For more information= , see the Remarks section.
|
|
|
5099 </summary>
|
|
|
5100 </member>
|
|
|
5101 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.GRAY_BRUSH">
|
|
|
5102 <summary>
|
|
|
5103 Gray brush.
|
|
|
5104 </summary>
|
|
|
5105 </member>
|
|
|
5106 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.HOLLOW_BRUSH">
|
|
|
5107 <summary>
|
|
|
5108 Hollow brush (equivalent to NULL_BRUSH).
|
|
|
5109 </summary>
|
|
|
5110 </member>
|
|
|
5111 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.LTGRAY_BRUSH">
|
|
|
5112 <summary>
|
|
|
5113 Light gray brush.
|
|
|
5114 </summary>
|
|
|
5115 </member>
|
|
|
5116 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.NULL_BRUSH">
|
|
|
5117 <summary>
|
|
|
5118 Null brush (equivalent to HOLLOW_BRUSH).
|
|
|
5119 </summary>
|
|
|
5120 </member>
|
|
|
5121 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.WHITE_BRUSH">
|
|
|
5122 <summary>
|
|
|
5123 White brush.
|
|
|
5124 </summary>
|
|
|
5125 </member>
|
|
|
5126 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.BLACK_PEN">
|
|
|
5127 <summary>
|
|
|
5128 Black pen.
|
|
|
5129 </summary>
|
|
|
5130 </member>
|
|
|
5131 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DC_PEN">
|
|
|
5132 <summary>
|
|
|
5133 Windows 2000/XP: Solid pen color. The default color is white. The color can be changed by using the SetDCPenColor function. For more information= , see the Remarks section.
|
|
|
5134 </summary>
|
|
|
5135 </member>
|
|
|
5136 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.WHITE_PEN">
|
|
|
5137 <summary>
|
|
|
5138 White pen.
|
|
|
5139 </summary>
|
|
|
5140 </member>
|
|
|
5141 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.ANSI_FIXED_FONT">
|
|
|
5142 <summary>
|
|
|
5143 Windows fixed-pitch (monospace) system font.
|
|
|
5144 </summary>
|
|
|
5145 </member>
|
|
|
5146 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.ANSI_VAR_FONT">
|
|
|
5147 <summary>
|
|
|
5148 Windows variable-pitch (proportional space) system font.
|
|
|
5149 </summary>
|
|
|
5150 </member>
|
|
|
5151 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DEVICE_DEFAULT_FONT">
|
|
|
5152 <summary>
|
|
|
5153 Windows NT/2000/XP: Device-dependent font.
|
|
|
5154 </summary>
|
|
|
5155 </member>
|
|
|
5156 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DEFAULT_GUI_FONT">
|
|
|
5157 <summary>
|
|
|
5158 Default font for user interface objects such as menus and dialog boxes. This is MS Sans Serif. Compare this with SYSTEM_FONT.
|
|
|
5159 </summary>
|
|
|
5160 </member>
|
|
|
5161 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.OEM_FIXED_FONT">
|
|
|
5162 <summary>
|
|
|
5163 Original equipment manufacturer (OEM) dependent fixed-pitch (monospace) font.
|
|
|
5164 </summary>
|
|
|
5165 </member>
|
|
|
5166 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.SYSTEM_FONT">
|
|
|
5167 <summary>
|
|
|
5168 System font. By default= , the system uses the system font to draw menus= , dialog box controls= , and text. Windows 95/98 and Windows NT: The system font is MS Sans Serif. Windows 2000/XP: The system font is Tahoma
|
|
|
5169 </summary>
|
|
|
5170 </member>
|
|
|
5171 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.SYSTEM_FIXED_FONT">
|
|
|
5172 <summary>
|
|
|
5173 Fixed-pitch (monospace) system font. This stock object is provided only for compatibility with 16-bit Windows versions earlier than 3.0.
|
|
|
5174 </summary>
|
|
|
5175 </member>
|
|
|
5176 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.StockObject.DEFAULT_PALETTE">
|
|
|
5177 <summary>
|
|
|
5178 Default palette. This palette consists of the static colors in the system palette.
|
|
|
5179 </summary>
|
|
|
5180 </member>
|
|
|
5181 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType">
|
|
|
5182 <summary>
|
|
|
5183 Values for <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.DrawFrameControl(System.IntPtr,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.Win32Declarations.FrameControlType,JetBrains.Interop.WinApi.Win32Declarations.FrameControlState)"/>.
|
|
|
5184 </summary>
|
|
|
5185 </member>
|
|
|
5186 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType.DFC_BUTTON">
|
|
|
5187 <summary>
|
|
|
5188 Standard button
|
|
|
5189 </summary>
|
|
|
5190 </member>
|
|
|
5191 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType.DFC_CAPTION">
|
|
|
5192 <summary>
|
|
|
5193 Title bar
|
|
|
5194 </summary>
|
|
|
5195 </member>
|
|
|
5196 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType.DFC_MENU">
|
|
|
5197 <summary>
|
|
|
5198 Menu bar
|
|
|
5199 </summary>
|
|
|
5200 </member>
|
|
|
5201 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType.DFC_POPUPMENU">
|
|
|
5202 <summary>
|
|
|
5203 Windows 98/Me, Windows 2000/XP: Popup menu item.
|
|
|
5204 </summary>
|
|
|
5205 </member>
|
|
|
5206 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlType.DFC_SCROLL">
|
|
|
5207 <summary>
|
|
|
5208 Scroll bar
|
|
|
5209 </summary>
|
|
|
5210 </member>
|
|
|
5211 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.FrameControlState">
|
|
|
5212 <summary>
|
|
|
5213 Values for <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.DrawFrameControl(System.IntPtr,JetBrains.Interop.WinApi.RECT@,JetBrains.Interop.WinApi.Win32Declarations.FrameControlType,JetBrains.Interop.WinApi.Win32Declarations.FrameControlState)"/>.
|
|
|
5214 Incomplete.
|
|
|
5215 </summary>
|
|
|
5216 </member>
|
|
|
5217 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.FrameControlState.DFCS_BUTTONPUSH">
|
|
|
5218 <summary>
|
|
|
5219 Push button
|
|
|
5220 </summary>
|
|
|
5221 </member>
|
|
|
5222 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags">
|
|
|
5223 <summary>
|
|
|
5224 Flags for the <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuEx(System.IntPtr,JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags,System.Int32,System.Int32,System.IntPtr,System.IntPtr)"/> function.
|
|
|
5225 </summary>
|
|
|
5226 </member>
|
|
|
5227 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_CENTERALIGN">
|
|
|
5228 <summary>
|
|
|
5229 If this flag is set, the function centers the shortcut menu horizontally relative to the coordinate specified by the x parameter.
|
|
|
5230 </summary>
|
|
|
5231 </member>
|
|
|
5232 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_LEFTALIGN">
|
|
|
5233 <summary>
|
|
|
5234 If this flag is set, the function positions the shortcut menu so that its left side is aligned with the coordinate specified by the x parameter.
|
|
|
5235 </summary>
|
|
|
5236 </member>
|
|
|
5237 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_RIGHTALIGN">
|
|
|
5238 <summary>
|
|
|
5239 Positions the shortcut menu so that its right side is aligned with the coordinate specified by the x parameter.
|
|
|
5240 </summary>
|
|
|
5241 </member>
|
|
|
5242 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_BOTTOMALIGN">
|
|
|
5243 <summary>
|
|
|
5244 If this flag is set, the function positions the shortcut menu so that its bottom side is aligned with the coordinate specified by the y parameter.
|
|
|
5245 </summary>
|
|
|
5246 </member>
|
|
|
5247 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_TOPALIGN">
|
|
|
5248 <summary>
|
|
|
5249 If this flag is set, the function positions the shortcut menu so that its top side is aligned with the coordinate specified by the y parameter.
|
|
|
5250 </summary>
|
|
|
5251 </member>
|
|
|
5252 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_VCENTERALIGN">
|
|
|
5253 <summary>
|
|
|
5254 If this flag is set, the function centers the shortcut menu vertically relative to the coordinate specified by the y parameter.
|
|
|
5255 </summary>
|
|
|
5256 </member>
|
|
|
5257 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_NONOTIFY">
|
|
|
5258 <summary>
|
|
|
5259 If this flag is set, the function does not send notification messages when the user clicks on a menu item.
|
|
|
5260 </summary>
|
|
|
5261 </member>
|
|
|
5262 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_RETURNCMD">
|
|
|
5263 <summary>
|
|
|
5264 If this flag is set, the function returns the menu item identifier of the user's selection in the return value.
|
|
|
5265 </summary>
|
|
|
5266 </member>
|
|
|
5267 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_LEFTBUTTON">
|
|
|
5268 <summary>
|
|
|
5269 If this flag is set, the user can select menu items with only the left mouse button.
|
|
|
5270 </summary>
|
|
|
5271 </member>
|
|
|
5272 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_RIGHTBUTTON">
|
|
|
5273 <summary>
|
|
|
5274 If this flag is set, the user can select menu items with both the left and right mouse buttons. /// </summary>
|
|
|
5275 </member>
|
|
|
5276 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_HORNEGANIMATION">
|
|
|
5277 <summary>
|
|
|
5278 Animates the menu from right to left.
|
|
|
5279 </summary>
|
|
|
5280 </member>
|
|
|
5281 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_HORPOSANIMATION">
|
|
|
5282 <summary>
|
|
|
5283 Animates the menu from left to right.
|
|
|
5284 </summary>
|
|
|
5285 </member>
|
|
|
5286 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_NOANIMATION">
|
|
|
5287 <summary>
|
|
|
5288 Displays menu without animation.
|
|
|
5289 </summary>
|
|
|
5290 </member>
|
|
|
5291 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_VERNEGANIMATION">
|
|
|
5292 <summary>
|
|
|
5293 Animates the menu from bottom to top.
|
|
|
5294 </summary>
|
|
|
5295 </member>
|
|
|
5296 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_VERPOSANIMATION">
|
|
|
5297 <summary>
|
|
|
5298 Animates the menu from top to bottom.
|
|
|
5299 For any animation to occur, the SystemParametersInfo function must set SPI_SETMENUANIMATION. Also, all the TPM_*ANIMATION flags, except TPM_NOANIMATION, are ignored if menu fade animation is on, See the SPI_GETMENUFADE flag in SystemParametersInfo.
|
|
|
5300 </summary>
|
|
|
5301 </member>
|
|
|
5302 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_HORIZONTAL">
|
|
|
5303 <summary>
|
|
|
5304 If the menu cannot be shown at the specified location without overlapping the excluded rectangle, the system tries to accommodate the requested horizontal alignment before the requested vertical alignment.
|
|
|
5305 </summary>
|
|
|
5306 </member>
|
|
|
5307 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.TrackPopupMenuExFlags.TPM_VERTICAL">
|
|
|
5308 <summary>
|
|
|
5309 If the menu cannot be shown at the specified location without overlapping the excluded rectangle, the system tries to accommodate the requested vertical alignment before the requested horizontal alignment.
|
|
|
5310 The excluded rectangle is a portion of the screen that the menu should not overlap; it is specified by lptpm.
|
|
|
5311 </summary>
|
|
|
5312 </member>
|
|
|
5313 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags">
|
|
|
5314 <summary>
|
|
|
5315 Flags that go along with the WM_SIZE message in its wParam.
|
|
|
5316 </summary>
|
|
|
5317 </member>
|
|
|
5318 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_RESTORED">
|
|
|
5319 <summary>
|
|
|
5320 The window has been resized, but neither the <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MINIMIZED"/> nor <see cref="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MAXIMIZED"/> value applies.
|
|
|
5321 </summary>
|
|
|
5322 </member>
|
|
|
5323 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MINIMIZED">
|
|
|
5324 <summary>
|
|
|
5325 The window has been minimized.
|
|
|
5326 </summary>
|
|
|
5327 </member>
|
|
|
5328 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MAXIMIZED">
|
|
|
5329 <summary>
|
|
|
5330 The window has been maximized.
|
|
|
5331 </summary>
|
|
|
5332 </member>
|
|
|
5333 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MAXSHOW">
|
|
|
5334 <summary>
|
|
|
5335 Message is sent to all pop-up windows when some other window has been restored to its former size.
|
|
|
5336 </summary>
|
|
|
5337 </member>
|
|
|
5338 <member name="F:JetBrains.Interop.WinApi.Win32Declarations.WmSizeFlags.SIZE_MAXHIDE">
|
|
|
5339 <summary>
|
|
|
5340 Message is sent to all pop-up windows when some other window is maximized.
|
|
|
5341 </summary>
|
|
|
5342 </member>
|
|
|
5343 <member name="T:JetBrains.Interop.WinApi.Win32Declarations.MARGINS">
|
|
|
5344 <summary>
|
|
|
5345 Returned by the GetThemeMargins function to define the margins of windows that have visual styles applied.
|
|
|
5346 </summary>
|
|
|
5347 </member>
|
|
|
5348 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.MARGINS.#ctor">
|
|
|
5349 <summary>
|
|
|
5350 Sets no margin.
|
|
|
5351 </summary>
|
|
|
5352 </member>
|
|
|
5353 <member name="M:JetBrains.Interop.WinApi.Win32Declarations.MARGINS.#ctor(System.Int32)">
|
|
|
5354 <summary>
|
|
|
5355 Sets all margins to the same value.
|
|
|
5356 </summary>
|
|
|
5357 </member>
|
|
|
5358 <member name="P:JetBrains.Interop.WinApi.Win32Declarations.MARGINS.WholeSurface">
|
|
|
5359 <summary>
|
|
|
5360 Sets the margins so that they cover the whole surface.
|
|
|
5361 </summary>
|
|
|
5362 </member>
|
|
|
5363 <member name="P:JetBrains.Interop.WinApi.Win32Declarations.MARGINS.Null">
|
|
|
5364 <summary>
|
|
|
5365 Sets the margins so that they cover none of the window inner surface.
|
|
|
5366 </summary>
|
|
|
5367 </member>
|
|
|
5368 <member name="M:JetBrains.Interop.WinApi.POINTAPI.#ctor(System.IntPtr)">
|
|
|
5369 <summary>
|
|
|
5370 Creates a new point, unpacking its signed coordinates from an LPARAM, using the <see cref="M:JetBrains.Interop.WinApi.Macros.GET_X_LPARAM(System.IntPtr)"/> and <see cref="M:JetBrains.Interop.WinApi.Macros.GET_Y_LPARAM(System.IntPtr)"/> functions.
|
|
|
5371 </summary>
|
|
|
5372 </member>
|
|
|
5373 <member name="M:JetBrains.Interop.WinApi.POINTAPI.ToString">
|
|
|
5374 <summary>
|
|
|
5375 Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
5376 </summary>
|
|
|
5377
|
|
|
5378 <returns>
|
|
|
5379 A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
|
5380 </returns>
|
|
|
5381 <filterpriority>2</filterpriority>
|
|
|
5382 </member>
|
|
|
5383 <member name="T:JetBrains.Interop.WinApi.HookType">
|
|
|
5384 <summary>
|
|
|
5385 Windows hook types for <see cref="M:JetBrains.Interop.WinApi.Win32Declarations.SetWindowsHookEx(JetBrains.Interop.WinApi.HookType,JetBrains.Interop.WinApi.Win32Declarations.HookProc,System.IntPtr,System.Int32)"/>.
|
|
|
5386 </summary>
|
|
|
5387 </member>
|
|
|
5388 <member name="T:JetBrains.Interop.WinApi.WindowsMessages">
|
|
|
5389 <summary>
|
|
|
5390 Windows message constants.
|
|
|
5391 </summary>
|
|
|
5392 </member>
|
|
|
5393 <member name="F:JetBrains.Interop.WinApi.WindowsMessages.WM_PRINT">
|
|
|
5394 <summary>
|
|
|
5395 The WM_PRINT message is sent to a window to request that it draw itself in the specified device context, most commonly in a printer device context.
|
|
|
5396 wParam is hdc, lParam is drawing options (PRF_…)
|
|
|
5397 </summary>
|
|
|
5398 </member>
|
|
|
5399 <member name="T:JetBrains.Interop.WinApi.WindowLongPtrIndex">
|
|
|
5400 <summary>
|
|
|
5401 Index constants for the <see cref="M:JetBrains.Interop.WinApi.User32Dll.GetWindowLongPtrW(System.Void*,System.Int32)"/> and <see cref="M:JetBrains.Interop.WinApi.User32Dll.SetWindowLongPtrW(System.Void*,System.Int32,System.Void*)"/> functions.
|
|
|
5402 </summary>
|
|
|
5403 </member>
|
|
|
5404 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWL_EXSTYLE">
|
|
|
5405 <summary>
|
|
|
5406 Sets a new extended window style. For more information, see CreateWindowEx.
|
|
|
5407 </summary>
|
|
|
5408 </member>
|
|
|
5409 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWL_STYLE">
|
|
|
5410 <summary>
|
|
|
5411 Sets a new window style.
|
|
|
5412 </summary>
|
|
|
5413 </member>
|
|
|
5414 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_WNDPROC">
|
|
|
5415 <summary>
|
|
|
5416 Sets a new address for the window procedure.
|
|
|
5417 Same as GWL_WNDPROC that is for non-“ptr” versions.
|
|
|
5418 </summary>
|
|
|
5419 </member>
|
|
|
5420 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_HINSTANCE">
|
|
|
5421 <summary>
|
|
|
5422 Sets a new application instance handle.
|
|
|
5423 Same as GWL_HINSTANCE that is for non-“ptr” versions.
|
|
|
5424 </summary>
|
|
|
5425 </member>
|
|
|
5426 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_HWNDPARENT">
|
|
|
5427 <summary>
|
|
|
5428 Do not call <see cref="M:JetBrains.Interop.WinApi.User32Dll.SetWindowLongPtrW(System.Void*,System.Int32,System.Void*)"/> with the <see cref="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_HWNDPARENT"/> index to change the parent of a child window. Instead, use the SetParent function.
|
|
|
5429 </summary>
|
|
|
5430 </member>
|
|
|
5431 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_ID">
|
|
|
5432 <summary>
|
|
|
5433 Sets a new identifier of the window.
|
|
|
5434 Same as GWL_ID that is for non-“ptr” versions.
|
|
|
5435 </summary>
|
|
|
5436 </member>
|
|
|
5437 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.GWLP_USERDATA">
|
|
|
5438 <summary>
|
|
|
5439 Sets the user data associated with the window. This data is intended for use by the application that created the window. Its value is initially zero.
|
|
|
5440 Same as GWL_USERDATA that is for non-“ptr” versions.
|
|
|
5441 </summary>
|
|
|
5442 </member>
|
|
|
5443 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.DWLP_DLGPROC">
|
|
|
5444 <summary>
|
|
|
5445 Sets the new pointer to the dialog box procedure.
|
|
|
5446 Valid for dialog boxes only.
|
|
|
5447 </summary>
|
|
|
5448 </member>
|
|
|
5449 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.DWLP_MSGRESULT">
|
|
|
5450 <summary>
|
|
|
5451 Sets the return value of a message processed in the dialog box procedure.
|
|
|
5452 Valid for dialog boxes only.
|
|
|
5453 </summary>
|
|
|
5454 </member>
|
|
|
5455 <member name="F:JetBrains.Interop.WinApi.WindowLongPtrIndex.DWLP_USER">
|
|
|
5456 <summary>
|
|
|
5457 Sets new extra information that is private to the application, such as handles or pointers.
|
|
|
5458 Valid for dialog boxes only.
|
|
|
5459 </summary>
|
|
|
5460 </member>
|
|
|
5461 <member name="T:JetBrains.Interop.WinApi.Win32InteropException">
|
|
|
5462 <summary>
|
|
|
5463 Denotes an exception that occurs during the interop calls.
|
|
|
5464 </summary>
|
|
|
5465 </member>
|
|
|
5466 <member name="T:JetBrains.Interop.WinApi.Wrappers.Win32Window">
|
|
|
5467 <summary>
|
|
|
5468 Implements the <see cref="T:System.Windows.Forms.IWin32Window"/> interface by just wrapping the handle.
|
|
|
5469 </summary>
|
|
|
5470 </member>
|
|
|
5471 <member name="M:JetBrains.Interop.WinApi.Wrappers.Win32Window.#ctor(System.IntPtr)">
|
|
|
5472 <summary>
|
|
|
5473 Wraps a native window handle.
|
|
|
5474 Can be <c>Null</c>.
|
|
|
5475 </summary>
|
|
|
5476 </member>
|
|
|
5477 <member name="M:JetBrains.Interop.WinApi.Wrappers.Win32Window.#ctor(System.Void*)">
|
|
|
5478 <summary>
|
|
|
5479 Wraps a native window handle.
|
|
|
5480 Can be <c>Null</c>.
|
|
|
5481 </summary>
|
|
|
5482 </member>
|
|
|
5483 <member name="P:JetBrains.Interop.WinApi.Wrappers.Win32Window.Handle">
|
|
|
5484 <summary>
|
|
|
5485 Gets the handle to the window represented by the implementer.
|
|
|
5486 </summary>
|
|
|
5487
|
|
|
5488 <returns>
|
|
|
5489 A handle to the window represented by the implementer.
|
|
|
5490 </returns>
|
|
|
5491 <filterpriority>1</filterpriority>
|
|
|
5492 </member>
|
|
|
5493 </members>
|
|
|
5494 </doc>
|
