SplStdGetBits: Difference between revisions
Appearance
Created page with "SplStdGetBits transfers data from the identified PM_Q_STD buffer into a buffer owned by the presentation driver. ==Syntax== SplStdGetBits(hstd, lStart, cBytes, pAddress); ..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
SplStdGetBits transfers data from the identified PM_Q_STD buffer into a buffer owned by the presentation driver. | SplStdGetBits transfers data from the identified PM_Q_STD buffer into a buffer owned by the presentation driver. | ||
==Syntax== | ==Syntax== | ||
SplStdGetBits(hstd, lStart, cBytes, pAddress) | SplStdGetBits(hstd, lStart, cBytes, pAddress) | ||
==Parameters== | ==Parameters== | ||
; hstd (HSTD) - input | ;hstd (HSTD) - input: The handle to PM_Q_STD data. | ||
: The handle to PM_Q_STD data. | ;lStart (LONG) - input: Offset to the byte at which transfer must start. Used when the data is obtained in a series of calls to SplStdGetBits. | ||
;cBytes (LONG) - input: The number of bytes to transfer. | |||
; lStart (LONG) - input | ;pAddress (PCH) - input: A pointer to the presentation driver's data buffer. | ||
: Offset to the byte at which transfer must start. Used when the data is obtained in a series of calls to SplStdGetBits. | |||
; cBytes (LONG) - input | |||
: The number of bytes to transfer. | |||
; pAddress (PCH) - input | |||
: A pointer to the presentation driver's data buffer. | |||
==Return Code== | ==Return Code== | ||
; fSuccess (BOOL) - returns | ;fSuccess (BOOL) - returns: Return codes. | ||
: Return codes. | |||
This function returns BOOLEAN (fSuccess). | This function returns BOOLEAN (fSuccess). | ||
* TRUE Success | * TRUE Success | ||
* FALSE Error | * FALSE Error | ||
==Remarks== | ==Remarks== | ||
Before calling SplStdGetBits, the presentation driver calls SplStdQueryLength to determine the length of the PM_Q_STD data. Depending upon the length, the hardcopy driver allocates a buffer large enough to contain all of the data, or allocates a smaller buffer and receives the data in a series of calls to SplStdGetBits. | Before calling SplStdGetBits, the presentation driver calls [[SplStdQueryLength]] to determine the length of the PM_Q_STD data. Depending upon the length, the hardcopy driver allocates a buffer large enough to contain all of the data, or allocates a smaller buffer and receives the data in a series of calls to SplStdGetBits. | ||
<PRE> | <PRE> | ||
#include <os2.h> | #include <os2.h> | ||
Line 39: | Line 30: | ||
fSuccess = SplStdGetBits(hstd, lStart, cBytes, pAddress); | fSuccess = SplStdGetBits(hstd, lStart, cBytes, pAddress); | ||
</PRE> | </PRE> | ||
[[Category:Spl]] | [[Category:Spl]] |
Latest revision as of 21:56, 25 March 2020
SplStdGetBits transfers data from the identified PM_Q_STD buffer into a buffer owned by the presentation driver.
Syntax
SplStdGetBits(hstd, lStart, cBytes, pAddress)
Parameters
- hstd (HSTD) - input
- The handle to PM_Q_STD data.
- lStart (LONG) - input
- Offset to the byte at which transfer must start. Used when the data is obtained in a series of calls to SplStdGetBits.
- cBytes (LONG) - input
- The number of bytes to transfer.
- pAddress (PCH) - input
- A pointer to the presentation driver's data buffer.
Return Code
- fSuccess (BOOL) - returns
- Return codes.
This function returns BOOLEAN (fSuccess).
- TRUE Success
- FALSE Error
Remarks
Before calling SplStdGetBits, the presentation driver calls SplStdQueryLength to determine the length of the PM_Q_STD data. Depending upon the length, the hardcopy driver allocates a buffer large enough to contain all of the data, or allocates a smaller buffer and receives the data in a series of calls to SplStdGetBits.
#include <os2.h> HSTD hstd; /* The handle to PM_Q_STD data. */ LONG lStart; LONG cBytes; /* The number of bytes to transfer. */ PCH pAddress; BOOL fSuccess; /* Return codes. */ fSuccess = SplStdGetBits(hstd, lStart, cBytes, pAddress);