PrfQueryProgramHandle: Difference between revisions

Latest revision as of 03:36, 25 November 2023

This function is used to obtain a handle for the requested executable file.

Syntax

PrfQueryProgramHandle (HINI hini, PCSZ pszExe, PHPROGARRAY phprogArray, ULONG cchBufferMax, PULONG pulCount)

Parameters

hini (HINI) - input: The initialization file handle

pszExe (PSZ) - input: Pointer to the executable file name string

phprogArray (PHPROGARRAY) - input: Pointer to array to receive program handles

cchBufferMax (ULONG) - input: The size of handles array

pulCount (PULONG) - input: The address at which to store the handles returned count

Returns

ulLength (ULONG) - return

Returns a program handle.

Remarks

Gets a list of the program handles associated with a given executable file name. This tells a caller if, and where, a given executable file is referenced in the program list.

The entries for the installed program list are kept in the OS2.INI file. They can therefore be accessed using the installation file function calls.

@@ Line 2: / Line 2: @@
 ==Syntax==
-  PrfQueryProgramHandle (HINI hini, PCSZ pszExe, PHPROGARRAY phprogArray, ULONG cchBufferMax, PULONG pulCount);
+  PrfQueryProgramHandle (HINI ''hini'', PCSZ ''pszExe'', PHPROGARRAY ''phprogArray'', ULONG ''cchBufferMax'', PULONG ''pulCount'')
 ==Parameters==
-;HINI
+;''hini'' (HINI) - input
 :The initialization file handle
-;PSZ
+;''pszExe'' (PSZ) - input
 :Pointer to the executable file name string
-;PHPROGARRAY
+;''phprogArray'' (PHPROGARRAY) - input
 :Pointer to array to receive program handles
-;ULONG
+;''cchBufferMax'' (ULONG) - input
 :The size of handles array
-;PULONG
+;''pulCount'' (PULONG) - input
 :The address at which to store the handles returned count
 ==Returns==
-Returns a program handle (ULONG).
+;''ulLength'' (ULONG) - return
+Returns a program handle.
 ==Remarks==