wcLoad( )

Syntax . . Returns . . Rules . . Tips . . Program Example . . Related Topics . . A-Z Index . . Home

Loads an AppPage and returns a handle to that page.

Example

returnCode = wcLoad(cntrlHandle, pageID, &pageHandle);

Syntax

int wcLoad(void *controlHandle, 
           char *MiVal,
           char **pageHandle)

controlHandle	The handle to the control structure.
MiVal	The page ID. If this argument is null, wcLoad( ) uses the value of the MIval parameter from the configuration file.
pageHandle	Out parameter used to return a handle to an AppPage.

Returns

0	Success.
Error code	Failure or exception. For a list of possible error codes, see Error Messages.

Rules

Before using wcLoad( ), you must first use wcDBOpen( ) to open the AppPages repository database connection.
wcLoad() uses MItab, MInam, and MIcol determine the page that will be loaded from the database. See Configuration File Parameters.

Tips

Use the returned handle as a parameter to WebExplode( ).

Program Example

The following code shows how wcLoad( ) is used in an application.

int handleRequest(wcp)
    void	*wcp;
{
    char    *pagePtr;
    char    *pageId;
    int     ret;

    wcGetVariable(wcp, "MIval", &pageId);
	
    if((ret = wcLoad(wcp, pageId, &pagePtr)) < 0)
		return wcTraceErr(wcp, ret);

    ret = WebExplode(wcp, pagePtr, NULL);

    if (pagePtr!=NULL)
        free(pagePtr);

    return (ret);
}