PDFix SDK  7.2.0
Loading...
Searching...
No Matches
PdsString Struct Referenceabstract

PdsString class. More...

#include <pdfix.h>

Inheritance diagram for PdsString:
PdsObject

Public Member Functions

virtual int GetValue (char *buffer, int len) const =0
 Gets the value of string object, and the string�s length. More...
 
virtual int GetText (wchar_t *buffer, int len) const =0
 Gets the unicode value of string object. More...
 
virtual bool IsHexValue () const =0
 Get information if the object is hex or literal string object. More...
 
- Public Member Functions inherited from PdsObject
virtual PdfObjectType GetObjectType () const =0
 Gets the type of an object. More...
 
virtual int GetId () const =0
 Gets the object number. More...
 
virtual int GetGenId () const =0
 Gets the generation number. More...
 
virtual PdfDocGetDoc () const =0
 Gets a reference to a document. More...
 
virtual PdsObjectClone (bool clone_indirect)=0
 Clone the object. More...
 
virtual bool RegisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0
 Registers a user-supplied procedure to call when the specified event occurs. More...
 
virtual bool UnregisterEvent (PdfEventType type, PdsObjectEventProc proc, void *data)=0
 

Detailed Description

PdsString class.

Member Function Documentation

◆ GetText()

virtual int PdsString::GetText ( wchar_t *  buffer,
int  len 
) const
pure virtual

Gets the unicode value of string object.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.
See also
PdeWord::GetValue

◆ GetValue()

virtual int PdsString::GetValue ( char *  buffer,
int  len 
) const
pure virtual

Gets the value of string object, and the string�s length.

Parameters
buffer(filled by method) If the buffer is null function returns required length of string data.
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.
See also
PdeWord::GetNumChars

◆ IsHexValue()

virtual bool PdsString::IsHexValue ( ) const
pure virtual

Get information if the object is hex or literal string object.

Returns
true if the object is hex, false otherwise.