GetFieldAccessW Function

This function is called by HotDocs to determine what type of access is allowed for a field in the answer source. Access may be read-only, or read/write, meaning answers can be written back to the original record if they are changed during the interview.

This function was introduced with the release of HotDocs 2009 to support Unicode strings. Earlier versions of HotDocs will not call this function.

Syntax

long GetFieldAccessW ( LPCWSTR szFieldName )

Parameters Description
szFieldName The name of the field that is to have its value retrieved.

Return Value

Return HD_READONLY (0) if only read access is allowed, or HD_READWRITE (1) if both read and write (back-fill) access is allowed.

Example (Visual C++)

The following Visual C++ example returns asks if read/write access is allowed:

long WINAPI GetFieldAccessW(LPCWSTR szFieldName)

{

  if (MessageBox(NULL, "Is read/write supported?", "GetFieldAccessW", MB_YESNO) == IDYES)

    return HD_READWRITE;

  else

    return HD_READONLY;

}