GpiBeginElement: Difference between revisions
Created page with "This function defines the start of an element within a segment. ==Syntax== GpiBeginElement(hps, lType, pszDesc) ==Parameters== ;hps (HPS) - input:Presentation-space handle...." |
No edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;hps (HPS) - input:Presentation-space handle. | ;hps ([[HPS]]) - input:Presentation-space handle. | ||
;lType (LONG) - input:Type to be associated with the element. | ;lType ([[LONG]]) - input:Type to be associated with the element. | ||
:Application-defined elements should have type values in the range 0x81xxxxxx through 0xFFxxxxxx to avoid conflict with system-generated elements. | :Application-defined elements should have type values in the range 0x81xxxxxx through 0xFFxxxxxx to avoid conflict with system-generated elements. | ||
;pszDesc (PSZ) - input:Description. | ;pszDesc ([[PSZ]]) - input:Description. | ||
:Variable-length character string, recorded with the type. | :Variable-length character string, recorded with the type. | ||
;rc (BOOL) - returns:Success indicator. | ;rc ([[BOOL]]) - returns:Success indicator. | ||
::TRUE Successful completion | ::TRUE Successful completion | ||
::FALSE Error occurred | ::FALSE Error occurred | ||
[[Category:Gpi]] | [[Category:Gpi]] | ||
Revision as of 14:59, 6 April 2024
This function defines the start of an element within a segment.
Syntax
GpiBeginElement(hps, lType, pszDesc)
Parameters
- hps (HPS) - input
- Presentation-space handle.
- lType (LONG) - input
- Type to be associated with the element.
- Application-defined elements should have type values in the range 0x81xxxxxx through 0xFFxxxxxx to avoid conflict with system-generated elements.
- pszDesc (PSZ) - input
- Description.
- Variable-length character string, recorded with the type.
- rc (BOOL) - returns
- Success indicator.
- TRUE Successful completion
- FALSE Error occurred