AdsDDGetViewProperty

Advantage Client Engine

Retrieves VIEW properties from an Advantage Data Dictionary. See Advantage SQL Engine for more specific VIEW documentation.

Syntax

UNSIGNED32 AdsDDGetViewProperty( ADSHANDLE hDBConn,

UNSIGNED8 *pucViewName,

UNSIGNED16 usPropertyID,

VOID *pvProperty,

UNSIGNED16 *pusPropertyLen );

Parameters

hDBConn (I)

Handle of a database connection.

pucViewName (I)

View to retrieve property.

usPropertyID (I)

Property to retrieve.

pvProperty (O)

Return property to this pointer.

pusPropertyLen (I/O)

pvProperty buffer length on input, number of bytes returned on output.

Remarks

AdsDDGetViewProperty returns a VIEW property from an Advantage Data Dictionary. The following values can be passed in the usPropertyID parameter:

ADS_DD_VIEW_STMT

Retrieves the view SQL statement from the dictionary. This property can only be retrieved by users with administrative permissions. See Advantage Data Dictionary User Permissions for more information.

ADS_DD_VIEW_STMT_LEN

Retrieves the length of the view SQL statement. Can be used to allocate a buffer before calling AdsDDGetViewProperty with the ADS_DD_VIEW_STMT option. This property can only be retrieved by users with administrative permissions. See Advantage Data Dictionary User Permissions for more information.

ADS_DD_COMMENT

Retrieves the optional comment set when creating the view.

Example

UNSIGNED8 aucBuff[256];

 

usLen = sizeof( aucBuff );

AdsDDGetViewProperty( hConn, "myview", ADS_DD_VIEW_STMT, aucBuff, &usLen );

See Also

AdsDDAddView

AdsDDRemoveView

AdsDDSetViewProperty

system.views