Advantage Client Engine
Retrieve a property of a published article from the data dictionary.
UNSIGNED32 ENTRYPOINT AdsDDGetArticleProperty( ADSHANDLE hDictionary,
UNSIGNED8 *pucPublicationName,
UNSIGNED8 *pucObjectName,
UNSIGNED16 usPropertyID,
VOID *pvProperty,
UNSIGNED16 *pusPropertyLen );
hDictionary (I) |
A data dictionary connection. |
pucPublicationName (I) |
The name of an existing publication in the dictionary. |
pucObjectName (I) |
The name of an article in the specified publication. |
usPropertyID (I) |
Index of the property to retrieve. See Remarks for allowed values. |
pvProperty (O) |
Pointer to the buffer where the property is to be copied into. |
pusPropertyLen (I/O) |
On input, specifies the size of the buffer pointed to by pvProperty. On output, returns the length of the property copied into the buffer. |
AE_INVALID_PROPERTY_ID |
Either the value supplied in usPropertyID is not a valid article property, or the specified property cannot be retrieved. |
AE_INSUFFICIENT_BUFFER |
The size of the property to be copied into pvProperty is larger than the buffer size specified by *pusPropertyLen. The required buffer length is returned in *pusPropertyLen when this error occurs. |
AE_PROPERTY_NOT_SET |
The requested property is not set in the data dictionary. No data is returned in pvProperty and *pusPropertylen. |
This function retrieves a property of the specified article in the specified publication from the data dictionary. The following are the valid values of usPropertyID and the expected return value in pvProperty and pusPropertyLen.
usPropertyID |
Description |
ADS_DD_COMMENT |
The comment for the article. |
ADS_DD_ARTICLE_FILTER |
The function returns the replication filter for the specified article. |
ADS_DD_ARTICLE_ID_COLUMNS |
The function returns the semicolon-delimited list of fields that are used to identify the record in the target table. |
ADS_DD_ARTICLE_INCLUDE_COLUMNS |
If the table has an inclusive vertical filter, this option retrieves the semicolon-delimited list of fields included in replication. This will be empty if there is no vertical filter or if the vertical filter is defined as an exclusion list of columns. |
ADS_DD_ARTICLE_EXCLUDE_COLUMNS |
If the table has an exclusive vertical filter, this option retrieves the semicolon-delimited list of fields excluded from replication. This will be empty if there is no vertical filter or if the vertical filter is defined as an inclusion list of columns. |
ADS_DD_ARTICLE_UPDATE_MERGE |
The function returns the flag that specifies whether or not this subscription uses SQL MERGE statements when performing UPDATEs. It is returned as a 2-byte integer in the buffer pointed to by pvProperty. *pusProperty must be 2 on input. |
ADS_DD_ARTICLE_INSERT_MERGE |
The function returns the flag that specifies whether or not this subscription uses SQL MERGE statements when performing INSERTs. It is returned as a 2-byte integer in the buffer pointed to by pvProperty. *pusProperty must be 2 on input. |
// retrieve the replication filter for an article
usLen = sizeof( aucBuf );
ulRetVal = AdsDDGetArticleProperty( hConn, "mypub", "table1",
ADS_DD_ARTICLE_FILTER, aucBuf, &usLen );
See Also