acedGetCfg

C++

inline int acedGetCfg(
    const ACHAR * sym, 
    ACHAR * var, 
    size_t len
);

File

acedads.h

Description

Deprecated. Retrieves application data from the AppData section of the acad.cfg file.

Note: This function is obsolete and will be removed in a future release. Move all CFG stored settings to the registry or elsewhere.

The sym argument must be a string of this form:

"AppData/application_name/section_name/.../parameter"

If the length of the string is greater than len, this function copies only the first len characters into var with no NULL terminator, and returns RTNORM. Otherwise, it copies the complete string, including a NULL terminator, into var and returns RTNORM.

Returns RTERROR if sym is not valid or is not found.

Parameters

Parameters	Description
sym	String (maximum length of 347 characters) naming the section and parameter value to retrieve
var	Pointer to a preallocated memory area large enough to hold the value to be retrieved plus a null terminator character
len	Size of the buffer to which the var argument points

Previous Declaration

int acedGetCfg(const ACHAR * sym, ACHAR * var ,int len);

Use Instead

ACCORE_PORT int acedGetCfg(const ACHAR * sym, AcString & sResult);