IBM Visualization Data Explorer Programmer's Reference

DXExtractNthString

Function

Determines whether an Object can be converted to a list of strings and, if so, extracts the nth one from it.

Syntax

#include <dx/dx.h>

Object DXExtractNthString(Object o, int n, char **cp)

Functional Details

If Object o contains at least an nth string (where n is a zero-based index), this routine extracts it and places a pointer to its first character in *cp.

Strings may be extracted from:

• String Objects (if n is 0)
• String lists (e.g., those created by DXMakeStringList and DXMakeStringListV).

Return Value

Returns o and sets cp if the nth string can be extracted from o; otherwise, returns NULL without setting an error code.

See Also

DXExtractFloat, DXExtractInteger, DXExtractParameter, DXExtractString, DXMakeStringList, DXMakeStringListV, DXQueryArrayConvert, DXQueryArrayConvertV, DXQueryParameter

12.8 , "Extracting Module Parameters".

[Data Explorer Home Page]