ade_prefgetval

Up a level

ade_prefgetval

Option Functions

Gets an AutoCAD Map option setting.

struct resbuf*

ade_prefgetval(

char* variable);

Returns an option value or NULL.

You must release the resbuf.

The function return value depends on which option you specify. The tables below show option names and return values, organized by option type.

The "ForceUserLogin" and "DoublePrec" system options cannot be modified unless your end user has superuser privileges.

If "DoublePrec" is set to 0, the behavior of data extension queries is the same as before introducing this option. The "DoublePrec" option has no user interface equivalent.

Database tables and database query categories are visible in the workspace only if "CheckTables" and "CheckQueries" are set to T and "CheckDatabases" is set to T also.

The following workspace options are read only. That is, they can be used only with ade_prefgetval to determine if a category is visible in the workspace.

The following sample parses the resbuf returned by ade_prefgetval() and prints the value for the specified option using a switch case statement. Then it releases the resbuf, as required.

char* pszOptionVar = "LogFileName";
struct resbuf* pGetPrefValRb = ade_prefgetval(pszOptionVar);
if(pGetPrefValRb != NULL){
    struct resbuf* rb = pGetPrefValRb;
    while(rb != NULL) {
        switch(rb->restype)
        {
            case RTT:
                acutPrintf(
                    "\nThe %s option variable contained the value: %d"
                    , pszOptionVar, rb->resval.rint);
                break;
            case RTSHORT:
                acutPrintf(
                    "\nThe %s option variable contained the value: %d"
                    , pszOptionVar, rb->resval.rint);
                break;
            case RTSTR:
                acutPrintf(
                    "\nThe %s option variable contained the value: %s"
                    , pszOptionVar, rb->resval.rstring);
                break;
            default:
                acutPrintf(
                    "\nCould not determine the value");
                break;
        }
        rb = rb->rbnext;
    }
}
else
{
    acutPrintf("\nNo value was assigned to %s."
        , pszOptionVar);
}
acutRelRb(pGetPrefValRb);