Xport Interface: document::frameset

Returns a pointer to the frameset element, if the document is an xhtml frameset document, and if the frameset element is present.

markup* document::frameset();1st Variety

  const markup* document::frameset() const;2nd Variety

Parameters

None

Returns

Returns a pointer to the frameset element, if the document is an xhtml frameset document, and if the frameset element is present. If either of these conditions are not satisfied, returns NULL.

Remarks

This operation is one of the more common operations in document. This operation allows a very convienient way to access frames in the frameset element of the document, and to add frames to the frameset as well. This function can also be called to check or verify that the frameset element exists.

Complexity

Constant

Example

#include "xhtml_doc.h"
#include <string>
#include <cassert>

int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml frameset root document
  fdocument doc(root_doc);

  // retrieve a pointer to the frameset element
  fmarkup* frmset = doc.frameset();
  assert(frmset != NULL);

  // clear the document of all elements
  doc.clear();

  // verify frameset element is not present
  frmset = doc.frameset();
  assert(frmset == NULL);

  return 0;
}