Jump to content

Application class/Help Image.Get Function Context Help Image method

From LabVIEW Wiki

Gets the context help image and function name for a given function ID.

VI Server Method Information
Method ID 868
Scope Private
Data Name Get Func Help Image
Short Name* Get Func Help Image
Long Name* Help Image:Get Function Context Help Image
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 1
Owning Class Name Application Class
Return Data Type Common Cluster TypeDef data type

Common Cluster TypeDef

Invoke Node Help Image:Get Function Context Help Image

Parameters

Data type Name Required Description
Common Cluster TypeDef Help Image:Get Function Context Help Image Yes. Return value. The context help image for the function identified by Function ID.
String Function Name Yes. Return value. The function name for the function identified by Function ID.
I32 Function ID Yes The ID of the function to get the context help image and function name.

Function IDs

The following list contains all function IDs as of LabVIEW 2019 SP1 (32-bit):

Function ID Function Name
0 Equal To 0?
1 Greater Or Equal To 0?
2 Less Or Equal To 0?
3 Not Equal To 0?
4 Greater Than 0?
5 Less Than 0?
6 Empty String/Path?
7 Decimal Digit?
8 Hex Digit?
9 Octal Digit?
10 Printable?
11 White Space?
12 Lexical Class
13 Not A Number/Path/Refnum?
14 Number To Decimal String
15 Number To Hexadecimal String
16 Number To Octal String
17 Number To Exponential String
18 Number To Fractional String
19 Number To Engineering String
20 Decimal String To Number
21 Hexadecimal String To Number
22 Octal String To Number
23 Fract/Exp String To Number
24 To Upper Case
25 To Lower Case
26 String Length
27 Reverse String
28 Rotate String
29 Not
30 Split Number
31 Path To String
32 String To Path
33 Round To Nearest
34 Increment
35 Decrement
36 Round Toward -Infinity
37 Absolute Value
38 Reciprocal
39 Negate
40 Square Root
41 Round Toward +Infinity
42 Sign
43 Complex Conjugate
44 Complex To Polar
45 Complex To Re/Im
46 Exponential
47 Natural Logarithm
48 Exponential (Arg) -1
49 Natural Logarithm (Arg +1)
50 Power Of 10
51 Logarithm Base 10
52 Power Of 2
53 Logarithm Base 2
54 To Byte Integer
55 To Word Integer
56 To Long Integer
57 To Quad Integer
58 To Unsigned Byte Integer
59 To Unsigned Word Integer
60 To Unsigned Long Integer
61 To Unsigned Quad Integer
62 To Single Precision Float
63 To Double Precision Float
64 To Extended Precision Float
65 To Single Precision Complex
66 To Double Precision Complex
67 To Extended Precision Complex
68 Mantissa & Exponent
69 Boolean To (0,1)
70 Swap Bytes
71 Swap Words
72 Sine
73 Cosine
74 Tangent
75 Cosecant
76 Secant
77 Cotangent
78 Inverse Sine
79 Inverse Cosine
80 Inverse Tangent
81 Hyperbolic Sine
82 Hyperbolic Cosine
83 Hyperbolic Tangent
84 Inverse Hyperbolic Sine
85 Inverse Hyperbolic Cosine
86 Inverse Hyperbolic Tangent
87 Sinc
88 Sine & Cosine
89 Power Of X
90 Logarithm Base X
91 Polar To Complex
92 Re/Im To Complex
93 Inverse Tangent (2 Input)
94 And
95 Not And
96 Or
97 Not Or
98 Exclusive Or
99 Not Exclusive Or
100 Implies
101 Logical Shift
102 Rotate
103 Add
104 Subtract
105 Multiply
106 Divide
107 Scale By Power Of 2
108 Quotient & Remainder
109 Equal?
110 Greater Or Equal?
111 Less Or Equal?
112 Not Equal?
113 Greater?
114 Less?
115 Join Numbers
116 Cast Unit Bases
117 Max & Min
118 In Range and Coerce
119 String Subset
120 Search/Split String
121 Index String Array
122 Append True/False String
123 Format Value
124 Pick Line
125 Match First String
126 Match True/False String
127 Scan Value
128 Match Pattern
129 Spreadsheet String To Array
130 Array To Spreadsheet String
131 Tick Count (ms)
132 Get Date/Time In Seconds
133 Date/Time To Seconds
134 Seconds To Date/Time
135 Random Number (0-1)
136 Select
137 Stop
138 Quit LabVIEW
139 Array Size
140 Get Date/Time String
141 Size Handle
142 Handle Peek
143 Handle Poke
144 Rotate Left With Carry
145 Rotate Right With Carry
146 Number To Boolean Array
147 Boolean Array To Number
148 String To Byte Array
149 Byte Array To String
152 Flatten To XML
153 Unflatten From XML
154 Flatten To JSON
155 Unflatten From JSON
156 Set Control Values by Index
157 Get Control Values by Index
158 Request Deallocation
159 Type Cast
160 Array To Cluster
161 Cluster To Array
162 One Button Dialog
163 Two Button Dialog
164 Wait (ms)
165 Wait Until Next ms Multiple
166 Wait For Front Panel Activity
167 Generate Front Panel Activity
168 Write Device
169 Read Device
170 Device Control/Status
171 Open Device
172 File Dialog
173 File Dialog
174 New Directory
175 Open File
176 New File
177 Close File
178 Flush File
179 Read File
180 Write File
181 Seek
182 EOF
183 Lock Range
184 Access Rights
185 Type and Creator
186 File/Directory Info
187 Volume Info
188 Move
189 Copy
190 Delete
191 List Directory
192 Build Path
193 Strip Path
194 Path Type
195 Array of Strings to Path
196 Path to Array of Strings
197 Refnum to Path
198 VI Library
199 Temporary Directory
200 Current VI's Path
201 Default Directory
202 Array Max & Min
203 Threshold 1D Array
204 Interpolate 1D Array
205 Sort 1D Array
206 Reverse 1D Array
207 Search 1D Array
208 Transpose 2D Array
209 Add Array Elements
210 Multiply Array Elements
211 Or Array Elements
212 And Array Elements
213 Rotate 1D Array
214 Split 1D Array
215 Swap Vector Element
216 Generate Occurrence
217 Wait on Occurrence
218 Set Occurrence
219 GPIB Write
220 GPIB Read
221 Wait for GPIB RQS
222 GPIB Trigger
223 GPIB Clear
224 GPIB Serial Poll
225 GPIB Misc
226 GPIB Initialization
227 GPIB Wait
228 GPIB Status
229 AllSpoll
230 DevClear
231 DevClearList
232 EnableLocal
233 EnableRemote
234 FindLstn
235 FindRQS
236 MakeAddr
237 PassControl
238 PPoll
239 PPollConfig
240 PPollUnconfig
241 RcvRespMsg
242 ReadStatus
243 Receive
244 ReceiveSetup
245 ResetSys
246 Send
247 SendCmds
248 SendDataBytes
249 SendIFC
250 SendList
251 SendLLO
252 SendSetup
253 SetRWLS
254 SetTimeOut
255 TestSRQ
256 TestSys
257 Trigger
258 TriggerList
259 WaitSRQ
260 Old VISA Open
261 VISA Close
262 VISA Find Resource
263 VISA Status Description
264 VISA Read
265 VISA Write
266 VISA Clear
267 VISA Read STB
268 VISA Assert Trigger
269 VISA In 16
270 VISA Out 16
271 VISA Map Address
272 VISA Unmap Address
273 VISA Peek 16
274 VISA Poke 16
275 VISA In 8
276 VISA Out 8
277 VISA Peek 8
278 VISA Poke 8
279 VISA Disable Event
280 VISA Discard Events
281 VISA Enable Event
282 VISA Wait on Event
283 VISA In 32
284 VISA In 64
285 VISA Out 32
286 VISA Out 64
287 VISA Move In 8
288 VISA Move Out 8
289 VISA Move In 16
290 VISA Move Out 16
291 VISA Move In 32
292 VISA Move In 64
293 VISA Move Out 32
294 VISA Move Out 64
295 VISA Lock
296 VISA Unlock
297 VISA Peek 32
298 VISA Peek 64
299 VISA Poke 32
300 VISA Poke 64
301 VISA Memory Allocation
302 VISA Memory Allocation Ex
303 VISA Memory Free
304 Call Chain
305 Control Help Window
306 Get Help Window Status
307 Control Online Help
308 String to Shared Variable
309 Shared Variable to String
310 IP To String
311 String To IP
312 TCP Wait On Listener
313 TCP Close Connection
314 TCP Write
315 TCP Open Connection
316 TCP Read
317 TCP Create Listener
318 TCP Flattened Read
319 TCP Flattened Write
320 TCP Flex Read
321 TCP Flex Write
322 Wait For Activity
323 UDP Open
324 UDP Read
325 UDP Write
326 UDP Close
327 UDP Multicast Open
328 VISA Refnum to Session
329 VISA Set I/O Buffer Size
330 VISA Flush I/O Buffer
331 VISA Move
332 Always Copy
333 Swap Values
334 Coerce To Type
335 ArrayMemInfo
336 RecomposeArray
337 DecomposeVariant
338 RecomposeVariant
339 DecomposeLockDataValRef
340 RecomposeUnlockDataValRef
341 New Data Value Reference
342 Delete Data Value Reference
343 Leak Variant Value Reference
344 Unleak Variant Value Reference
345 To Probe String
346 Automation Open
347 Automation Close
348 To OLE Variant
349 Variant To Data
350 Open VI Reference
351 Close Reference
352 Open Application Reference
353 Format Date/Time String
354 Scan String For Tokens
355 IVI New Session
356 IVI Delete Session
357 Current VI's Menubar
358 Get Menu Selection
359 Enable Menu Tracking
360 Insert Menu Items
361 Delete Menu Items
362 Get Menu Item Info
363 Set Menu Item Info
364 Get Menu Short Cut Info
365 Refnum to Session
366 Session to Refnum
367 VISA GPIB Control REN
368 VISA VXI Cmd or Query
369 Open VI Object Reference
370 New VI
371 New VI Object
372 To Variant
373 Flattened String To Variant
374 Variant To Flattened String
375 Set Variant Attribute
376 Get Variant Attribute
377 Delete Variant Attribute
378 Set Waveform Attribute
379 Get Waveform Attribute
380 Delete Waveform Attribute
381 First Call?
382 DataSocket Open
383 DataSocket Close
384 DataSocket Read
385 DataSocket Write
386 Open/Create/Replace File
387 Read from Binary File
388 Close File
389 Copy
390 Open/Create/Replace Datalog
391 Create Folder
392 Delete
393 Deny Access
394 File Dialog
395 Flush File
396 Get Datalog Position
397 Get File Position
398 Get File Size
399 Get Number of Records
400 Get Permissions
401 Get Type and Creator
402 Get Volume Info
403 Move
404 Read Datalog
405 Read from Text File
406 Set Datalog Position
407 Set File Position
408 Set File Size
409 Set Number of Records
410 Set Permissions
411 Set Type and Creator
412 Write to Binary File
413 Write Datalog
414 Write to Text File
415 TDMS Write
416 TDMS Read
417 TDMS Open
418 TDMS Close
419 TDMS Set Properties
420 TDMS Get Properties
421 TDMS List Contents
422 TDMS Flush
423 TDMS Write IP
424 TDMS Defragment
425 TDMS Refnum To File ID
426 TDMS Advanced Open
427 TDMS Set Channel Information
428 TDMS Reserve File Size
429 TDMS Configure Asynchronous Writes
430 TDMS Set Next Write Position
431 TDMS Advanced Synchronous Write
432 TDMS Advanced Asynchronous Write
433 TDMS Configure Asynchronous Reads
434 TDMS Start Asynchronous Reads
435 TDMS Advanced Synchronous Read
436 TDMS Advanced Asynchronous Read
437 TDMS Stop Asynchronous Reads
438 TDMS Get Asynchronous Write Status
439 TDMS Advanced Close
440 TDMS Set Next Read Position
441 TDMS Get Asynchronous Read Status
442 TDMS Advanced Asynchronous Write (Data Ref)
443 TDMS Advanced Asynchronous Read (Data Ref)
444 TDMS Configure Asynchronous Writes (Data Ref)
445 TDMS Configure Asynchronous Reads (Data Ref)
446 TDMS Get Asynchronous Write Status (Data Ref)
447 TDMS Get Asynchronous Read Status (Data Ref)
448 TDMS In Memory Open
449 TDMS In Memory Close
450 TDMS In Memory Read Bytes
451 TDMS Delete Data
452 File/Directory Info
453 List Folder
454 Replace Substring
455 Search and Replace String
456 To More Specific Class
457 To More Generic Class
458 Preserve Run-Time Class
459 VISA Open
460 VISA Assert Interrupt Signal
461 VISA Assert Utility Signal
462 VISA Map Trigger
463 VISA Unmap Trigger
464 VISA Read To File
465 VISA Write From File
466 VISA GPIB Command
467 VISA GPIB Control ATN
468 VISA GPIB Pass Control
469 VISA GPIB Send IFC
471 Obtain Notifier
472 Release Notifier
473 Get Notifier Status
474 Send Notification
475 Wait on Notification
476 Wait on Notification with Notifier History
477 Wait on Notification from Multiple
478 Wait on Notification from Multiple with Notifier History
479 Cancel Notification
480 Obtain Queue
481 Release Queue
482 Get Queue Status
483 Enqueue Element
484 Lossy Enqueue Element
485 Preview Queue Element
486 Dequeue Element
487 Flush Queue
488 Enqueue Element At Opposite End
489 IrDA Create Listener
490 IrDA Discover
491 IrDA Open Connection
492 Register Session
493 Unregister Session
494 To Time Stamp
495 To Fixed-Point
496 Create User Event
497 Generate User Event
498 Destroy User Event
499 Unregister For Events
500 Add
501 Subtract
502 Multiply
503 Divide
504 VISA USB Control In
505 VISA USB Control Out
506 Bluetooth Create Listener
507 Bluetooth Discover
508 Bluetooth Open Connection
509 Inverse Cosecant
510 Inverse Secant
511 Inverse Cotangent
512 Hyperbolic Cosecant
513 Hyperbolic Secant
514 Hyperbolic Cotangent
515 Inverse Hyperbolic Cosecant
516 Inverse Hyperbolic Secant
517 Inverse Hyperbolic Cotangent
518 Square
519 Re/Im To Polar
520 Polar To Re/Im
521 Y-th Root of X
522 Empty Array?
523 Get Drag Drop Data
524 Flatten To String
525 Unflatten From String
526 Unpackage Matrix
527 Package Matrix
528 Floating Point Equal?
529 Sort Array of String
530 Text to UTF-8
531 UTF-8 to Text
532 Lookup Channel Probe
533 RT FIFO Create
534 RT FIFO Read
535 RT FIFO Write
536 RT FIFO Delete
537 Bitpack to Array
538 Unbitpack from Array
539 Matrix Size
540 Resize Matrix
541 Transpose Matrix
542 Generate User-Defined Trace Event
543 Clear Fixed-Point Overflow Status
544 Remove Fixed-Point Overflow Status
545 Include Fixed-Point Overflow Status
546 Fixed-Point Overflow?
547 Fixed-Point to Integer Cast
548 Integer to Fixed-Point Cast
549 CPU Information
550 Current Processor ID
551 Data Cache Size
552 Number of Cache Levels
553 Close Variable Connection
554 Destroy Stream Endpoint
555 Flush Stream
556 Create Network Stream Writer Endpoint
557 Create Network Stream Reader Endpoint
558 Create Network Stream Endpoint
559 Create Unique Network Stream Writer Endpoint
560 Create Unique Network Stream Reader Endpoint
561 Create Unique Network Stream Endpoint
562 Transpose 1D Array
563 Dynamic FPGA Interface Cast
564 Open Dynamic Bitfile Reference
565 Search Variable Container
566 Resource Index
567 FPGA Refnum to Session
568 Preallocated Read from Binary File
569 Flush Event Queue
570 Type Of
571 Type Error
572 Assert Structural Type Match
573 Type Must Be Array
574 Type Must Be Cluster
575 Open Python Session
576 Close Python Session
577 Collection Size
578 Empty Collection?
579 Insert Into Set
580 Remove From Set
581 Element of Set?
582 Read Set Max & Min
583 Insert Into Map
584 Remove From Map
585 Look In Map
586 Read Map Max & Min Keys
587 New TLS Configuration
588 Start TLS
589 Accept TLS
590 Load Private Key Into Memory
591 Load Certificates Into Memory
592 Add Private Key To TLS Configuration
593 Add Trusted Certificate To TLS Configuration
594 Make TLS Configuration Immutable
595 Add Entropy
596 Re-accept TLS
597 TLS Connection?

Uses

This method is useful for documentation purposes and to provide context help for built-in functions, when the function ID is known.

Returns the context help image/ the icon and inputs and outputs, for the specified function. This method requires the function's index or resld. The name of the function is returned which allows the calling vi to use this method to build a table from which a name to image lookup is possible. This method was implemented for the sole purpose of helping out the documentation and localization folks. If you are using it for something else talk to me and/or test well.

Source: Context Help

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links