Detailed instructions for use are in the User's Guide.
[. . . ] PrintForm Programmer's Guide to Custom DLLs
PrintForm 7. 90c Revision 1 February 2009
Copyright information
© 2009 SAP® BusinessObjectsTM. SAP BusinessObjects owns the following United States patents, which may cover products that are offered and licensed by SAP BusinessObjects and/or affiliated companies: 5, 295, 243; 5, 339, 390; 5, 555, 403; 5, 590, 250; 5, 619, 632; 5, 632, 009; 5, 857, 205; 5, 880, 742; 5, 883, 635; 6, 085, 202; 6, 108, 698; 6, 247, 008; 6, 289, 352; 6, 300, 957; 6, 377, 259; 6, 490, 593; 6, 578, 027; 6, 581, 068; 6, 628, 312; 6, 654, 761; 6, 768, 986; 6, 772, 409; 6, 831, 668; 6, 882, 998; 6, 892, 189; 6, 901, 555; 7, 089, 238; 7, 107, 266; 7, 139, 766; 7, 178, 099; 7, 181, 435; 7, 181, 440; 7, 194, 465; 7, 222, 130; 7, 299, 419; 7, 320, 122; 7, 356, 779 and 7, 475, 062. SAP BusinessObjects and its logos, BusinessObjects, Crystal Reports®, SAP BusinessObjects Rapid MartTM, SAP BusinessObjects Data InsightTM, SAP BusinessObjects Desktop Intelligence, SAP BusinessObjects Rapid Marts®, SAP BusinessObjects Watchlist SecurityTM, SAP BusinessObjects Web Intelligence®, and Xcelsius® are trademarks or registered trademarks of Business Objects, an SAP company and/or affiliated companies in the United States and/or other countries. SAP® is a registered trademark of SAP AG in Germany and/or other countries. [. . . ] ResetLine, SetLineText, InsertLineText, ReplaceLineText, GetTextCount
Chapter 3: SFLine functions
53
CSFLine::GetTextCount (void)
Return Value Parameters Remarks Example See also
int None None
Number of text bytes contained in the line object text buffer
See class example #1 on page 24. ResetLine, SetLineText, InsertLineText, ReplaceLineText, GetLineText
54
PrintForm Programmer's Guide to Custom DLLs
CSFLine::ResetLine(void)
Return Value Parameters Remarks
None None Resets all member attributes and deletes all associated overprint line objects. Zeros out the line text buffer.
Example
See class example #1 on page 24.
Chapter 3: SFLine functions
55
CSFLine::GetSerializedSize (short shVersion=PF_NULL_VERSION)
Return Value
long
Line objects serialized size in bytes. Currently supports objects up to slightly larger than 2GB. Serialized object version.
Parameters Remarks Example See also
short shVersion
None
See this documents class level example #3. Serialize, Deserialize
56
PrintForm Programmer's Guide to Custom DLLs
CSFLine::Serialize (BFILE* pbfFile)
Return Value
long
Line objects serialized size in bytes. Currently supports objects up to slightly larger than 2GB. File pointer where serialized data is to be written
Parameters Remarks Example See also
BFILE* pbfFile
Returned value zero upon failure. See this documents class level example #3. GetSerializedSize, Deserialize
Chapter 3: SFLine functions
57
CSFLine::Deserialize (BFILE* pbfFile)
Return Value
long
Line objects deserialized size in bytes. Currently supports objects up to slightly larger than 2GB. File pointer where serialized data is to be read
Parameters Remarks
BFILE* pbfFile
Returned value zero upon failure. errstat is set upon failure.
Example See also
See this documents class level example #3. GetSerializedSize, Serialize
58
PrintForm Programmer's Guide to Custom DLLs
CSFLine::GetObjectID()
Return Value
PFOBJECT_IDS
Enumerated list of object ID types. The enumerated object types are contained in the header file PFObject. h.
Parameters Remarks Example
None None See this documents class level example #3.
Chapter 3: SFLine functions
59
CSFLine::GetOverprintsOnLine (void)
Return Value Parameters Remarks Example See also
int None None
Number of overprint lines contained in the list
See this documents class level example #2. GetFirstOverprintLine, GetNextOverprintLine, GetOverprintLine, AddOverprintLine, RemoveOverprintLine, ResetLine, MergeOverprintLines
60
PrintForm Programmer's Guide to Custom DLLs
CSFLine::GetFirstOverprintLine (void)
Return Value Parameters Remarks
CSFLine* None
Pointer to CSFLine object
Does not remove the CSFLine object from the overprint list. Do not delete the CSFLine object returned from this method. Returns a NULL pointer if no objects exist in the overprint list.
Example See also
See this documents class level example #2. GetOverprintsOnLine, GetNextOverprintLine, GetOverprintLine, AddOverprintLine, RemoveOverprintLine, ResetLine, MergeOverprintLines
Chapter 3: SFLine functions
61
CSFLine::GetNextOverprintLine (void)
Return Value Parameters Remarks
CSFLine* None
Pointer to CSFLine object
Does not remove the CSFLine object from the overprint list. Do not delete the CSFLine object returned from this method. If GetFirstOverprintLine has not previously been invoked, the head list object is returned. Returns a NULL pointer if all entries in the list have been processed. [. . . ] Defaults to the first line of the page.
Remarks
CSFLine pointer should be freed and/or deleted after use (unless added back into a CSFPage object). CSFLine pointer is NULL upon failure.
Example
See the class level example #1 on page 68.
105
CSFPage::AllocateLine
CSFLine* AllocateLine(void)
Return Value Parameters Remarks
CSFLine* None
Pointer to CSFLine object
CSFLine object memory may originate from an internal line hold buffer. Lines are added into the internal hold buffer by the ResetPage method. CSFLine pointer should be freed and/or deleted after use (unless added into a CSFPage object). [. . . ]