VioCreateLogFont: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
VioCreateLogFont(attrs, lcid, Name, hvps) | VioCreateLogFont(attrs, lcid, Name, hvps) | ||
==Parameters== | ==Parameters== | ||
;attrs ( | ;attrs (P[[FATTRS]]) - input : Pointer to the font attribute structure. | ||
;lcid (ULONG) - input : Local identifier. | ;lcid (ULONG) - input : Local identifier. | ||
:This must be a value in the range 1 to 3. It is an error if lcid is already in use. | :This must be a value in the range 1 to 3. It is an error if lcid is already in use. | ||
| Line 11: | Line 11: | ||
:This string is optional and is used to describe the logical font. | :This string is optional and is used to describe the logical font. | ||
;hvps (HVIO) - input : VIO presentation-space handle. | ;hvps (HVIO) - input : VIO presentation-space handle. | ||
:This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS. | :This is either 0 to indicate the default VIO session, or a value returned by [[VioCreatePS]]. | ||
==Return Code== | ==Return Code== | ||
;rc (APIRET) - returns:VioCreateLogFont returns one of the following values: | |||
VioCreateLogFont returns one of the following values: | * 0 NO_ERROR | ||
* 0 | * 421 ERROR_VIO_INVALID_PARMS | ||
* 421 | * 436 ERROR_VIO_INVALID_HANDLE | ||
* 436 | |||
==Remarks== | ==Remarks== | ||
Latest revision as of 03:49, 17 January 2019
Specifies a font for use by a VIO session.
Syntax
VioCreateLogFont(attrs, lcid, Name, hvps)
Parameters
- attrs (PFATTRS) - input
- Pointer to the font attribute structure.
- lcid (ULONG) - input
- Local identifier.
- This must be a value in the range 1 to 3. It is an error if lcid is already in use.
- Name (STR8) - input
- Logical font name.
- This string is optional and is used to describe the logical font.
- hvps (HVIO) - input
- VIO presentation-space handle.
- This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS.
Return Code
- rc (APIRET) - returns
- VioCreateLogFont returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 436 ERROR_VIO_INVALID_HANDLE
Remarks
The system selects the font most closely matching the specified font from the set of monospaced fonts installed in the system.
In OS/2 2.x, hvps cannot be 0.