IDBInfo::GetKeywords

Returns a list of provider-specific keywords.

HRESULT GetKeywords(
   LPOLESTR *   ppwszKeywords);

Parameters

ppwszKeywords

[out]
A pointer to memory in which to return the address of a string. The string contains a comma-separated list of all keywords unique to this provider; that is, a comma-separated list of keywords that are not in the list in the Comments section. If there are no keywords unique to this provider, or if an error occurs, the provider sets *ppwszKeywords to a null pointer.

The provider allocates memory for the string and returns the address to this memory; the consumer releases this memory with IMalloc::Free when it no longer needs the string.

Return Code

S_OK
The method succeeded.

E_FAIL
A provider-specific error occurred.

E_INVALIDARG
ppwszKeywords was a null pointer.

E_OUTOFMEMORY
The provider was unable to allocate sufficient memory in which to return the keywords.

E_UNEXPECTED
The data source object was in an uninitialized state.

Comments

The following table lists the keywords from OLE DB.

ABSOLUTE INTO
ACTION IS
ADD ISOLATION
ALL JOIN
ALLOCATE KEY
ALTER LANGUAGE
AND LAST
ANY LEADING
ARE LEFT
AS LEVEL
ASC LIKE
ASSERTION LOCAL
AT LOWER
AUTHORIZATION MATCH
AVG MAX
BEGIN MIN
BETWEEN MINUTE
BIT MODULE
BIT_LENGTH MONTH
BOTH NAMES
BY NATIONAL
CASCADE NATURAL
CASCADED NCHAR
CASE NEXT
CAST NO
CATALOG NOT
CHAR NULL
CHAR_LENGTH NULLIF
CHARACTER NUMERIC
CHARACTER_LENGTH OCTET_LENGTH
CHECK OF
CLOSE ON
COALESCE ONLY
COLLATE OPEN
COLLATION OPTION
COLUMN OR
COMMIT ORDER
CONNECT OUTER
CONNECTION OUTPUT
CONSTRAINT OVERLAPS
CONSTRAINTS PARTIAL
CONTINUE POSITION
CONVERT PRECISION
CORRESPONDING PREPARE
COUNT PRESERVE
CREATE PRIMARY
CROSS PRIOR
CURRENT PRIVILEGES
CURRENT_DATE PROCEDURE
CURRENT_TIME PUBLIC
CURRENT_TIMESTAMP READ
CURRENT_USER REAL
CURSOR REFERENCES
DATE RELATIVE
DAY RESTRICT
DEALLOCATE REVOKE
DEC RIGHT
DECIMAL ROLLBACK
DECLARE ROWS
DEFAULT SCHEMA
DEFERRABLE SCROLL
DEFERRED SECOND
DELETE SECTION
DESC SELECT
DESCRIBE SESSION
DESCRIPTOR SESSION_USER
DIAGNOSTICS SET
DISCONNECT SIZE
DISTINCT SMALLINT
DISTINCTROW SOME
DOMAIN SQL
DOUBLE SQLCODE
DROP SQLERROR
ELSE SQLSTATE
END SUBSTRING
END-EXEC SUM
ESCAPE SYSTEM_USER
EXCEPT TABLE
EXCEPTION TEMPORARY
EXEC THEN
EXECUTE TIME
EXISTS TIMESTAMP
EXTERNAL TIMEZONE_HOUR
EXTRACT TIMEZONE_MINUTE
FALSE TO
FETCH TRAILING
FIRST TRANSACTION
FLOAT TRANSLATE
FOR TRANSLATION
FOREIGN TRIGGER
FOUND TRIM
FROM TRUE
FULL UNION
GET UNIQUE
GLOBAL UNKNOWN
GO UPDATE
GOTO UPPER
GRANT USAGE
GROUP USER
HAVING USING
HOUR VALUE
IDENTITY VALUES
IMMEDIATE VARCHAR
IN VARYING
INDICATOR VIEW
INITIALLY WHEN
INNER WHENEVER
INPUT WHERE
INSENSITIVE WITH
INSERT WORK
INT WRITE
INTEGER YEAR
INTERSECT ZONE
INTERVAL

See Also

IDBInfo::GetLiteralInfo, IDBProperties::GetProperties