|
2 | 2 | title: "FRAMEINFO_FLAGS | Microsoft Docs"
|
3 | 3 | ms.date: "11/04/2016"
|
4 | 4 | ms.topic: "conceptual"
|
5 |
| -f1_keywords: |
| 5 | +f1_keywords: |
6 | 6 | - "FRAMEINFO_FLAGS"
|
7 |
| -helpviewer_keywords: |
| 7 | +helpviewer_keywords: |
8 | 8 | - "FRAMEINFO_FLAGS enumeration"
|
9 | 9 | ms.assetid: 41578062-8455-412a-9d8b-1e1e9dc8d52e
|
10 | 10 | author: "gregvanl"
|
11 | 11 | ms.author: "gregvanl"
|
12 | 12 | manager: jillfra
|
13 |
| -ms.workload: |
| 13 | +ms.workload: |
14 | 14 | - "vssdk"
|
15 | 15 | ---
|
16 | 16 | # FRAMEINFO_FLAGS
|
17 |
| -Specifies the information to retrieve about a stack frame object. |
18 |
| - |
19 |
| -## Syntax |
20 |
| - |
21 |
| -```cpp |
22 |
| -enum enum_FRAMEINFO_FLAGS { |
23 |
| - FIF_FUNCNAME = 0x00000001, |
24 |
| - FIF_RETURNTYPE = 0x00000002, |
25 |
| - FIF_ARGS = 0x00000004, |
26 |
| - FIF_LANGUAGE = 0x00000008, |
27 |
| - FIF_MODULE = 0x00000010, |
28 |
| - FIF_STACKRANGE = 0x00000020, |
29 |
| - FIF_FRAME = 0x00000040, |
30 |
| - FIF_DEBUGINFO = 0x00000080, |
31 |
| - FIF_STALECODE = 0x00000100, |
32 |
| - FIF_ANNOTATEDFRAME = 0x00000200, |
33 |
| - FIF_DEBUG_MODULEP = 0x00000400, |
34 |
| - FIF_FUNCNAME_FORMAT = 0x00001000, |
35 |
| - FIF_FUNCNAME_RETURNTYPE = 0x00002000, |
36 |
| - FIF_FUNCNAME_ARGS = 0x00004000, |
37 |
| - FIF_FUNCNAME_LANGUAGE = 0x00008000, |
38 |
| - FIF_FUNCNAME_MODULE = 0x00010000, |
39 |
| - FIF_FUNCNAME_LINES = 0x00020000, |
40 |
| - FIF_FUNCNAME_OFFSET = 0x00040000, |
41 |
| - FIF_FUNCNAME_ARGS_TYPES = 0x00100000, |
42 |
| - FIF_FUNCNAME_ARGS_NAMES = 0x00200000, |
43 |
| - FIF_FUNCNAME_ARGS_VALUES = 0x00400000, |
44 |
| - FIF_FUNCNAME_ARGS_ALL = 0x00700000, |
45 |
| - FIF_ARGS_TYPES = 0x01000000, |
46 |
| - FIF_ARGS_NAMES = 0x02000000, |
47 |
| - FIF_ARGS_VALUES = 0x04000000, |
48 |
| - FIF_ARGS_ALL = 0x07000000, |
49 |
| - FIF_ARGS_NOFORMAT = 0x08000000, |
50 |
| - FIF_ARGS_NO_FUNC_EVAL = 0x10000000, |
51 |
| - FIF_FILTER_NON_USER_CODE = 0x20000000, |
52 |
| - FIF_ARGS_NO_TOSTRING = 0x40000000, |
53 |
| - FIF_DESIGN_TIME_EXPR_EVAL = 0x80000000 |
54 |
| -}; |
55 |
| -typedef DWORD FRAMEINFO_FLAGS; |
56 |
| -``` |
57 |
| - |
58 |
| -```csharp |
59 |
| -public enum enum_FRAMEINFO_FLAGS { |
60 |
| - FIF_FUNCNAME = 0x00000001, |
61 |
| - FIF_RETURNTYPE = 0x00000002, |
62 |
| - FIF_ARGS = 0x00000004, |
63 |
| - FIF_LANGUAGE = 0x00000008, |
64 |
| - FIF_MODULE = 0x00000010, |
65 |
| - FIF_STACKRANGE = 0x00000020, |
66 |
| - FIF_FRAME = 0x00000040, |
67 |
| - FIF_DEBUGINFO = 0x00000080, |
68 |
| - FIF_STALECODE = 0x00000100, |
69 |
| - FIF_ANNOTATEDFRAME = 0x00000200, |
70 |
| - FIF_DEBUG_MODULEP = 0x00000400, |
71 |
| - FIF_FUNCNAME_FORMAT = 0x00001000, |
72 |
| - FIF_FUNCNAME_RETURNTYPE = 0x00002000, |
73 |
| - FIF_FUNCNAME_ARGS = 0x00004000, |
74 |
| - FIF_FUNCNAME_LANGUAGE = 0x00008000, |
75 |
| - FIF_FUNCNAME_MODULE = 0x00010000, |
76 |
| - FIF_FUNCNAME_LINES = 0x00020000, |
77 |
| - FIF_FUNCNAME_OFFSET = 0x00040000, |
78 |
| - FIF_FUNCNAME_ARGS_TYPES = 0x00100000, |
79 |
| - FIF_FUNCNAME_ARGS_NAMES = 0x00200000, |
80 |
| - FIF_FUNCNAME_ARGS_VALUES = 0x00400000, |
81 |
| - FIF_FUNCNAME_ARGS_ALL = 0x00700000, |
82 |
| - FIF_ARGS_TYPES = 0x01000000, |
83 |
| - FIF_ARGS_NAMES = 0x02000000, |
84 |
| - FIF_ARGS_VALUES = 0x04000000, |
85 |
| - FIF_ARGS_ALL = 0x07000000, |
86 |
| - FIF_ARGS_NOFORMAT = 0x08000000, |
87 |
| - FIF_ARGS_NO_FUNC_EVAL = 0x10000000, |
88 |
| - FIF_FILTER_NON_USER_CODE = 0x20000000, |
89 |
| - FIF_ARGS_NO_TOSTRING = 0x40000000, |
90 |
| - FIF_DESIGN_TIME_EXPR_EVAL = 0x80000000 |
91 |
| -}; |
92 |
| -``` |
93 |
| - |
94 |
| -## Members |
95 |
| - FIF_FUNCNAME |
96 |
| - Initialize/use the `m_bstrFuncName` field. |
97 |
| - |
98 |
| - FIF_RETURNTYPE |
99 |
| - Initialize/use the `m_bstrReturnType` field. |
100 |
| - |
101 |
| - FIF_ARGS |
102 |
| - Initialize/use the `m_bstrArgs` field. |
103 |
| - |
104 |
| - FIF_LANGUAGE |
105 |
| - Initialize/use the `m_bstrLanguage` field. |
106 |
| - |
107 |
| - FIF_MODULE |
108 |
| - Initialize/use the `m_bstrModule` field. |
109 |
| - |
110 |
| - FIF_STACKRANGE |
111 |
| - Initialize/use the `m_addrMin` and `m_addrMax` (stack range) fields. |
112 |
| - |
113 |
| - FIF_FRAME |
114 |
| - Initialize/use the `m_pFrame` field. |
115 |
| - |
116 |
| - FIF_DEBUGINFO |
117 |
| - Initialize/use the `m_fHasDebugInfo` field. |
118 |
| - |
119 |
| - FIF_STALECODE |
120 |
| - Initialize/use the `m_fStaleCode` field. |
121 |
| - |
122 |
| - FIF_ANNOTATEDFRAME |
123 |
| - Initialize/use the `m_fAnnotatedFrame` field. |
124 |
| - |
125 |
| - FIF_DEBUG_MODULEP |
126 |
| - Initialize/use the `m_pModule` field. |
127 |
| - |
128 |
| - FIF_FUNCNAME_FORMAT |
129 |
| - Formats the function name. The result is returned in the `m_bstrFunName` field and no other fields are filled out. |
130 |
| - |
131 |
| - FIF_FUNCNAME_RETURNTYPE |
132 |
| - Adds the return type to the `m_bstrFuncName` field. |
133 |
| - |
134 |
| - FIF_FUNCNAME_ARGS |
135 |
| - Adds the arguments to the `m_bstrFuncName` field. |
136 |
| - |
137 |
| - FIF_FUNCNAME_LANGUAGE |
138 |
| - Adds the language to the `m_bstrFuncName` field. |
139 |
| - |
140 |
| - FIF_FUNCNAME_MODULE |
141 |
| - Adds the module name to the `m_bstrFuncName` field. |
142 |
| - |
143 |
| - FIF_FUNCNAME_LINES |
144 |
| - Adds the number of lines to the `m_bstrFuncName` field. |
145 |
| - |
146 |
| - FIF_FUNCNAME_OFFSET |
147 |
| - Adds to the `m_bstrFuncName` field the offset in bytes from the start of the line if `FIF_FUNCNAME_LINES` is specified. If `FIF_FUNCNAME_LINES` is not specified, or if line numbers are not available, adds the offset in bytes from the start of the function. |
148 |
| - |
149 |
| - FIF_FUNCNAME_ARGS_TYPES |
150 |
| - Adds the type of each function argument to the `m_bstrFuncName` field. |
151 |
| - |
152 |
| - FIF_FUNCNAME_ARGS_NAMES |
153 |
| - Adds the name of each function argument to the `m_bstrFuncName` field. |
154 |
| - |
155 |
| - FIF_FUNCNAME_ARGS_VALUES |
156 |
| - Adds the value of each function argument to the `m_bstrFuncName` field. |
157 |
| - |
158 |
| - FIF_FUNCNAME_ARGS_ALL |
159 |
| - Adds the type, name, and value of all arguments to the `m_bstrFuncName` field. |
160 |
| - |
161 |
| - FIF_ARGS_TYPES |
162 |
| - The argument types are retrieved and formatted. |
163 |
| - |
164 |
| - FIF_ARGS_NAMES |
165 |
| - The argument names are retrieved and formatted. |
166 |
| - |
167 |
| - FIF_ARGS_VALUES |
168 |
| - The argument values are retrieved and formatted. |
169 |
| - |
170 |
| - FIF_ARGS_ALL |
171 |
| - Retrieve and format the type, name, and value of all arguments. |
172 |
| - |
173 |
| - FIF_ARGS_NOFORMAT |
174 |
| - Specifies that the arguments are not be formatted (for example, do not add opening and closing parentheses around the argument list nor add a separator between arguments). |
175 |
| - |
176 |
| - FIF_ARGS_NO_FUNC_EVAL |
177 |
| - Specifies that function (property) evaluation should not be used when retrieving argument values. |
178 |
| - |
179 |
| - FIF_FILTER_NON_USER_CODE |
180 |
| - The debug engine is to filter non-user code frames so they are not included. |
181 |
| - |
182 |
| - FIF_ARGS_NO_TOSTRING |
183 |
| - Do not allow `ToString()` function evaluation or formatting when returning function arguments. |
184 |
| - |
185 |
| - FIF_DESIGN_TIME_EXPR_EVAL |
186 |
| - Frame information should be gotten from the hosted app-domain rather than the hosting process. |
187 |
| - |
188 |
| -## Remarks |
189 |
| - These flags are passed to the [EnumFrameInfo](../../../extensibility/debugger/reference/idebugthread2-enumframeinfo.md) and [GetInfo](../../../extensibility/debugger/reference/idebugstackframe2-getinfo.md) methods to indicate which fields are to be initialized in the [FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) structure or structures. |
190 |
| - |
191 |
| - These flags are also used to indicate which fields of the [FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) structure are used and valid when the structure is returned. These values may be combined with a bitwise `OR`. |
192 |
| - |
193 |
| -## Requirements |
194 |
| - Header: msdbg.h |
195 |
| - |
196 |
| - Namespace: Microsoft.VisualStudio.Debugger.Interop |
197 |
| - |
198 |
| - Assembly: Microsoft.VisualStudio.Debugger.Interop.dll |
199 |
| - |
200 |
| -## See Also |
201 |
| - [Enumerations](../../../extensibility/debugger/reference/enumerations-visual-studio-debugging.md) |
202 |
| - [FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) |
203 |
| - [EnumFrameInfo](../../../extensibility/debugger/reference/idebugthread2-enumframeinfo.md) |
204 |
| - [GetInfo](../../../extensibility/debugger/reference/idebugstackframe2-getinfo.md) |
| 17 | +Specifies the information to retrieve about a stack frame object. |
| 18 | + |
| 19 | +## Syntax |
| 20 | + |
| 21 | +```cpp |
| 22 | +enum enum_FRAMEINFO_FLAGS { |
| 23 | + FIF_FUNCNAME = 0x00000001, |
| 24 | + FIF_RETURNTYPE = 0x00000002, |
| 25 | + FIF_ARGS = 0x00000004, |
| 26 | + FIF_LANGUAGE = 0x00000008, |
| 27 | + FIF_MODULE = 0x00000010, |
| 28 | + FIF_STACKRANGE = 0x00000020, |
| 29 | + FIF_FRAME = 0x00000040, |
| 30 | + FIF_DEBUGINFO = 0x00000080, |
| 31 | + FIF_STALECODE = 0x00000100, |
| 32 | + FIF_ANNOTATEDFRAME = 0x00000200, |
| 33 | + FIF_DEBUG_MODULEP = 0x00000400, |
| 34 | + FIF_FUNCNAME_FORMAT = 0x00001000, |
| 35 | + FIF_FUNCNAME_RETURNTYPE = 0x00002000, |
| 36 | + FIF_FUNCNAME_ARGS = 0x00004000, |
| 37 | + FIF_FUNCNAME_LANGUAGE = 0x00008000, |
| 38 | + FIF_FUNCNAME_MODULE = 0x00010000, |
| 39 | + FIF_FUNCNAME_LINES = 0x00020000, |
| 40 | + FIF_FUNCNAME_OFFSET = 0x00040000, |
| 41 | + FIF_FUNCNAME_ARGS_TYPES = 0x00100000, |
| 42 | + FIF_FUNCNAME_ARGS_NAMES = 0x00200000, |
| 43 | + FIF_FUNCNAME_ARGS_VALUES = 0x00400000, |
| 44 | + FIF_FUNCNAME_ARGS_ALL = 0x00700000, |
| 45 | + FIF_ARGS_TYPES = 0x01000000, |
| 46 | + FIF_ARGS_NAMES = 0x02000000, |
| 47 | + FIF_ARGS_VALUES = 0x04000000, |
| 48 | + FIF_ARGS_ALL = 0x07000000, |
| 49 | + FIF_ARGS_NOFORMAT = 0x08000000, |
| 50 | + FIF_ARGS_NO_FUNC_EVAL = 0x10000000, |
| 51 | + FIF_FILTER_NON_USER_CODE = 0x20000000, |
| 52 | + FIF_ARGS_NO_TOSTRING = 0x40000000, |
| 53 | + FIF_DESIGN_TIME_EXPR_EVAL = 0x80000000 |
| 54 | +}; |
| 55 | +typedef DWORD FRAMEINFO_FLAGS; |
| 56 | +``` |
| 57 | + |
| 58 | +```csharp |
| 59 | +public enum enum_FRAMEINFO_FLAGS { |
| 60 | + FIF_FUNCNAME = 0x00000001, |
| 61 | + FIF_RETURNTYPE = 0x00000002, |
| 62 | + FIF_ARGS = 0x00000004, |
| 63 | + FIF_LANGUAGE = 0x00000008, |
| 64 | + FIF_MODULE = 0x00000010, |
| 65 | + FIF_STACKRANGE = 0x00000020, |
| 66 | + FIF_FRAME = 0x00000040, |
| 67 | + FIF_DEBUGINFO = 0x00000080, |
| 68 | + FIF_STALECODE = 0x00000100, |
| 69 | + FIF_ANNOTATEDFRAME = 0x00000200, |
| 70 | + FIF_DEBUG_MODULEP = 0x00000400, |
| 71 | + FIF_FUNCNAME_FORMAT = 0x00001000, |
| 72 | + FIF_FUNCNAME_RETURNTYPE = 0x00002000, |
| 73 | + FIF_FUNCNAME_ARGS = 0x00004000, |
| 74 | + FIF_FUNCNAME_LANGUAGE = 0x00008000, |
| 75 | + FIF_FUNCNAME_MODULE = 0x00010000, |
| 76 | + FIF_FUNCNAME_LINES = 0x00020000, |
| 77 | + FIF_FUNCNAME_OFFSET = 0x00040000, |
| 78 | + FIF_FUNCNAME_ARGS_TYPES = 0x00100000, |
| 79 | + FIF_FUNCNAME_ARGS_NAMES = 0x00200000, |
| 80 | + FIF_FUNCNAME_ARGS_VALUES = 0x00400000, |
| 81 | + FIF_FUNCNAME_ARGS_ALL = 0x00700000, |
| 82 | + FIF_ARGS_TYPES = 0x01000000, |
| 83 | + FIF_ARGS_NAMES = 0x02000000, |
| 84 | + FIF_ARGS_VALUES = 0x04000000, |
| 85 | + FIF_ARGS_ALL = 0x07000000, |
| 86 | + FIF_ARGS_NOFORMAT = 0x08000000, |
| 87 | + FIF_ARGS_NO_FUNC_EVAL = 0x10000000, |
| 88 | + FIF_FILTER_NON_USER_CODE = 0x20000000, |
| 89 | + FIF_ARGS_NO_TOSTRING = 0x40000000, |
| 90 | + FIF_DESIGN_TIME_EXPR_EVAL = 0x80000000 |
| 91 | +}; |
| 92 | +``` |
| 93 | + |
| 94 | +## Members |
| 95 | +FIF_FUNCNAME |
| 96 | +Initialize/use the `m_bstrFuncName` field. |
| 97 | + |
| 98 | +FIF_RETURNTYPE |
| 99 | +Initialize/use the `m_bstrReturnType` field. |
| 100 | + |
| 101 | +FIF_ARGS |
| 102 | +Initialize/use the `m_bstrArgs` field. |
| 103 | + |
| 104 | +FIF_LANGUAGE |
| 105 | +Initialize/use the `m_bstrLanguage` field. |
| 106 | + |
| 107 | +FIF_MODULE |
| 108 | +Initialize/use the `m_bstrModule` field. |
| 109 | + |
| 110 | +FIF_STACKRANGE |
| 111 | +Initialize/use the `m_addrMin` and `m_addrMax` (stack range) fields. |
| 112 | + |
| 113 | +FIF_FRAME |
| 114 | +Initialize/use the `m_pFrame` field. |
| 115 | + |
| 116 | +FIF_DEBUGINFO |
| 117 | +Initialize/use the `m_fHasDebugInfo` field. |
| 118 | + |
| 119 | +FIF_STALECODE |
| 120 | +Initialize/use the `m_fStaleCode` field. |
| 121 | + |
| 122 | +FIF_ANNOTATEDFRAME |
| 123 | +Initialize/use the `m_fAnnotatedFrame` field. |
| 124 | + |
| 125 | +FIF_DEBUG_MODULEP |
| 126 | +Initialize/use the `m_pModule` field. |
| 127 | + |
| 128 | +FIF_FUNCNAME_FORMAT |
| 129 | +Formats the function name. The result is returned in the `m_bstrFunName` field and no other fields are filled out. |
| 130 | + |
| 131 | +FIF_FUNCNAME_RETURNTYPE |
| 132 | +Adds the return type to the `m_bstrFuncName` field. |
| 133 | + |
| 134 | +FIF_FUNCNAME_ARGS |
| 135 | +Adds the arguments to the `m_bstrFuncName` field. |
| 136 | + |
| 137 | +FIF_FUNCNAME_LANGUAGE |
| 138 | +Adds the language to the `m_bstrFuncName` field. |
| 139 | + |
| 140 | +FIF_FUNCNAME_MODULE |
| 141 | +Adds the module name to the `m_bstrFuncName` field. |
| 142 | + |
| 143 | +FIF_FUNCNAME_LINES |
| 144 | +Adds the number of lines to the `m_bstrFuncName` field. |
| 145 | + |
| 146 | +FIF_FUNCNAME_OFFSET |
| 147 | +Adds to the `m_bstrFuncName` field the offset in bytes from the start of the line if `FIF_FUNCNAME_LINES` is specified. If `FIF_FUNCNAME_LINES` is not specified, or if line numbers are not available, adds the offset in bytes from the start of the function. |
| 148 | + |
| 149 | +FIF_FUNCNAME_ARGS_TYPES |
| 150 | +Adds the type of each function argument to the `m_bstrFuncName` field. |
| 151 | + |
| 152 | +FIF_FUNCNAME_ARGS_NAMES |
| 153 | +Adds the name of each function argument to the `m_bstrFuncName` field. |
| 154 | + |
| 155 | +FIF_FUNCNAME_ARGS_VALUES |
| 156 | +Adds the value of each function argument to the `m_bstrFuncName` field. |
| 157 | + |
| 158 | +FIF_FUNCNAME_ARGS_ALL |
| 159 | +Adds the type, name, and value of all arguments to the `m_bstrFuncName` field. |
| 160 | + |
| 161 | +FIF_ARGS_TYPES |
| 162 | +The argument types are retrieved and formatted. |
| 163 | + |
| 164 | +FIF_ARGS_NAMES |
| 165 | +The argument names are retrieved and formatted. |
| 166 | + |
| 167 | +FIF_ARGS_VALUES |
| 168 | +The argument values are retrieved and formatted. |
| 169 | + |
| 170 | +FIF_ARGS_ALL |
| 171 | +Retrieve and format the type, name, and value of all arguments. |
| 172 | + |
| 173 | +FIF_ARGS_NOFORMAT |
| 174 | +Specifies that the arguments are not be formatted (for example, do not add opening and closing parentheses around the argument list nor add a separator between arguments). |
| 175 | + |
| 176 | +FIF_ARGS_NO_FUNC_EVAL |
| 177 | +Specifies that function (property) evaluation should not be used when retrieving argument values. |
| 178 | + |
| 179 | +FIF_FILTER_NON_USER_CODE |
| 180 | +The debug engine is to filter non-user code frames so they are not included. |
| 181 | + |
| 182 | +FIF_ARGS_NO_TOSTRING |
| 183 | +Do not allow `ToString()` function evaluation or formatting when returning function arguments. |
| 184 | + |
| 185 | +FIF_DESIGN_TIME_EXPR_EVAL |
| 186 | +Frame information should be gotten from the hosted app-domain rather than the hosting process. |
| 187 | + |
| 188 | +## Remarks |
| 189 | +These flags are passed to the [EnumFrameInfo](../../../extensibility/debugger/reference/idebugthread2-enumframeinfo.md) and [GetInfo](../../../extensibility/debugger/reference/idebugstackframe2-getinfo.md) methods to indicate which fields are to be initialized in the [FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) structure or structures. |
| 190 | + |
| 191 | +These flags are also used to indicate which fields of the [FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) structure are used and valid when the structure is returned. These values may be combined with a bitwise `OR`. |
| 192 | + |
| 193 | +## Requirements |
| 194 | +Header: msdbg.h |
| 195 | + |
| 196 | +Namespace: Microsoft.VisualStudio.Debugger.Interop |
| 197 | + |
| 198 | +Assembly: Microsoft.VisualStudio.Debugger.Interop.dll |
| 199 | + |
| 200 | +## See Also |
| 201 | +[Enumerations](../../../extensibility/debugger/reference/enumerations-visual-studio-debugging.md) |
| 202 | +[FRAMEINFO](../../../extensibility/debugger/reference/frameinfo.md) |
| 203 | +[EnumFrameInfo](../../../extensibility/debugger/reference/idebugthread2-enumframeinfo.md) |
| 204 | +[GetInfo](../../../extensibility/debugger/reference/idebugstackframe2-getinfo.md) |
0 commit comments