OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
climpabrowser.c.
This file contains methods for processing browser command.
Return Type Method Summary
U_CHAR* BrowserAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* BrowserUsage(U_CHAR *errStatus)
             This function will be called when browser command is received with invalid options.
U_CHAR* CdAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* CdUsage(U_CHAR *errStatus)
             This function will be called when cd command is received with invalid options.
void FreeBrowserCommand()
             Frees resources allocated for the list.
void FreeCdCommand()
             Frees resources allocated for the list.
void FreeLsCommand()
             Frees resources allocated for the list.
void FreePwdCommand()
             Frees resources allocated for the list.
CHAR InitBrowser()
             This method is called at agent startup.
CHAR InitBrowserParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitCLIMPABrowserHandler()
             This method is called at agent startup.
CHAR InitCd()
             This method is called at agent startup.
CHAR InitCdParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitLs()
             This method is called at agent startup.
CHAR InitLsParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitPwd()
             This method is called at agent startup.
U_CHAR* LsAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* LsUsage(U_CHAR *errStatus)
             This function will be called when ls command is received with invalid options.
U_CHAR* PwdAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* PwdUsage(U_CHAR *errStatus)
             This function will be called when pwd command is received with invalid options.
   
Method Details

BrowserAction().

U_CHAR* BrowserAction(StringCommand * commandPtr,ClientSession *clientSesPtr,void *infoPtr,U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs : .

BrowserUsage().

CHAR* BrowserUsage( U_CHAR *errStatus)

This function will be called when browser command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

CdAction().

U_CHAR* CdAction(StringCommand * commandPtr,ClientSession *clientSesPtr,void *infoPtr,U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs : .

CdUsage().

CHAR* CdUsage( U_CHAR *errStatus)

This function will be called when cd command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

FreeBrowserCommand().

void FreeBrowserCommand(void)

Frees resources allocated for the list.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeCdCommand().

void FreeCdCommand(void)

Frees resources allocated for the list.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeLsCommand().

void FreeLsCommand(void)

Frees resources allocated for the list.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreePwdCommand().

void FreePwdCommand(void)

Frees resources allocated for the list.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

InitBrowser().

CHAR InitBrowser(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitBrowserParameter().

CHAR InitBrowserParameter(StringCommand *cmdPtr,U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitCLIMPABrowserHandler().

CHAR InitCLIMPABrowserHandler(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitCd()

CHAR InitCd(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitCdParameter().

CHAR InitCdParameter(StringCommand *cmdPtr,U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitLs()

CHAR InitLs(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitLsParameter().

CHAR InitLsParameter(StringCommand *cmdPtr,U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitPwd()

CHAR InitPwd(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

LsAction().

U_CHAR* LsAction(StringCommand * commandPtr,ClientSession *clientSesPtr,void *infoPtr,U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs : .

LsUsage().

CHAR* LsUsage( U_CHAR *errStatus)

This function will be called when ls command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

PwdAction().

U_CHAR* PwdAction(StringCommand * commandPtr,ClientSession *clientSesPtr,void *infoPtr,U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs : .

PwdUsage().

CHAR* PwdUsage( U_CHAR *errStatus)

This function will be called when pwd command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :
OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.