DeRegisterCommand

Unregisters a console command and its parsing function.

Library:LibC
Classification:NetWare OS
Service:NetWare Platform

Syntax

  #include <netware.h> 
   
  int DeRegisterCommand (
     void         *NLMHandle,
     rtag_t        rTag,
     uint32_t      keywordFlags,
     const char   *keyword); 
  

Parameters

NLMHandle

(IN) Points to the NLM associated with this console command.

rTag

(IN) Specifies the resource tag that was used when registering the console command.

keywordFlags

(IN) Specifies the data type of keyword with one of the following flags:

Flag

Value

Description

CMD_MSG_NUMBER

0x80000000

The keyword is a message number.

CMD_LENGTH_PREC

0x40000000

The keyword is a length-preceded string.

keyword

(IN) Points to the keyword that was used to register the console command.

Return Values

If successful, returns 0. Otherwise, returns one of the following error codes.

Decimal

Constant

Description

0x00000001

ERR_INVALID_MODULE

The NLM handle is invalid.

0x00000002

ERR_INVALID_RTAG

The resource tag is invalid.

0x00000003

ERR_INVALID_KEYWORD

The keyword is invalid because it is NULL.

0x00000004

ERR_MODULE_RTAG_MIX

The resource tag doesn't belong to the NLM.

0x00000006

ERR_KEYWORD_TOO_LONG

The keyword is longer than 48 bytes.

0x00000009

ERR_FAILED_TOO_REGISTER

The command has not been registered.

Remarks

This function should be called to unregister a command parsing function previously defined with RegisterCommand. If the command is a chainable command, only this instance is unregistered.

See Also

RegisterCommand