rwlogo

Rogue Wave DBLink API Reference Guide

Product Documentation:

Rogue Wave DBLink
Documentation Home

List of all members | Public Member Functions
IldSynonym Class Reference

Instances of the class IldSynonym hold the description of a synonym. More...

#include <ildblink/ildsyn.h>

Inheritance diagram for IldSynonym:
IldSchemaEntity

Public Member Functions

virtual ~IldSynonym ()
 This destructor deletes the link and target strings from the current object.
 
const char * getLink () const
 Get the related link. More...
 
const char * getTarget () const
 Get the target name. More...
 
const char * getTargetOwner () const
 Get the target owner. More...
 
- Public Member Functions inherited from IldSchemaEntity
virtual ~IldSchemaEntity ()
 This virtual destructor is invoked when any instance of a subclass from IldSchemaEntity is being destroyed. More...
 
IldDbmsgetDbms () const
 Get the attached to connection object. More...
 
IldEntityType getEntityType () const
 Get the type of the entity. More...
 
IlInt getId () const
 get the identifier of the entity. More...
 
const char * getName () const
 Get the name of the entity. More...
 
const char * getOwner () const
 Get the owner of the entity. More...
 

Detailed Description

Instances of the class IldSynonym hold the description of a synonym.

Library: dbkernel

As with all schema entity descriptor classes, this class is intended to be used on a read-only basis.

See Also
IldSchemaEntity

Member Function Documentation

const char * IldSynonym::getLink ( ) const

Get the related link.

Returns
The name of the database link to which the synonym is related, if any.
Warning
The returned value must not be modified nor destroyed.
const char * IldSynonym::getTarget ( ) const

Get the target name.

Returns
The name of the entity for which the object is a synonym.
const char * IldSynonym::getTargetOwner ( ) const

Get the target owner.

Returns
The owner of the entity for which this object is a synonym.

© Copyright 2014, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.