XPath Property

Provides a way to point to a specific element in the document.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

@property (nonatomic,readwrite,assign,getter=XPath,setter=setXPath:) NSString* XPath;
- (NSString*)XPath;
- (void)setXPath:(NSString*)newXPath;

#define PID_QBOBJECT_XPATH 14

INQB_EXTERNAL void* INQB_CALL InQB_QBObject_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
INQB_EXTERNAL int INQB_CALL InQB_QBObject_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML response.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

When XPath is set to a valid path, XElement points to the name of the element, with XChildren and XText providing other properties of the element.

Example (Setting XPath)

 Document root    
QBObjectControl.XPath = "/"
 Specific Element 
QBObjectControl.XPath = "/root/SubElement1/SubElement2/"
 i-th Child       
QBObjectControl.XPath = "/root/[i]"

You may use the HasXPath method to determine if an xpath exists before setting the XPath property.

This property is not available at design time.

Data Type

String